Griffe FastAPI Extension

This extension will search for functions that are decorated with an APIRouter and adds the following extra fields to a function:

• api: the path of the api
• method: the HTTP method
• responses: A dictionary with the responses

These fields are stored in the extra property of the function. The extra property is a dictionary and griffe_fastapi is the key for the fields of this extension.

A fastapi template is used to handle these extra fields in your documentation.

Installation

pip install griffe-fastapi

or with poetry:

poetry add griffe-fastapi -G docs

When you use a group, like above, you also need to install it:

poetry install -G docs

MkDocs

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_fastapi

Configuration

• paths select only apply griffe-fastapi for the given paths
• generate_table Add a table in the docstring with the http response codes (default=True)