https://github.com/fbraem/griffe-fastapi
Griffe extension for FastAPI
https://github.com/fbraem/griffe-fastapi
fastapi griffe-extension mkdocs mkdocstrings
Last synced: about 2 months ago
JSON representation
Griffe extension for FastAPI
- Host: GitHub
- URL: https://github.com/fbraem/griffe-fastapi
- Owner: fbraem
- License: mit
- Created: 2024-11-15T18:48:55.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-12-07T14:54:18.000Z (5 months ago)
- Last Synced: 2025-01-18T15:30:46.685Z (3 months ago)
- Topics: fastapi, griffe-extension, mkdocs, mkdocstrings
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
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)