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
````
Raw data
{
"_id": null,
"home_page": null,
"name": "griffe-fastapi",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "griffe, griffe-extensions, fastapi",
"author": "fbraem",
"author_email": "franky.braem@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/14/a5/db1f5bd071959df3d8c27059f067a8fe8ede600d062ecef300d5f9a1c102/griffe_fastapi-0.1.5.tar.gz",
"platform": null,
"description": "Griffe FastAPI Extension\n========================\n\nThis extension will search for functions that are decorated with an APIRouter and adds the following extra\nfields to a function:\n\n+ api: the path of the api\n+ method: the HTTP method\n+ responses: A dictionary with the responses\n\nThese fields are stored in the extra property of the function. The extra property is a dictionary and `griffe_fastapi`\nis the key for the fields of this extension.\n\nA fastapi template is used to handle these extra fields in your documentation.\n\nInstallation\n------------\n\n````\npip install griffe-fastapi\n````\n\nor with poetry:\n\n````\npoetry add griffe-fastapi -G docs\n````\n\nWhen you use a group, like above, you also need to install it:\n\n````\npoetry install -G docs\n````\n\nMkDocs\n------\n\n````\nplugins:\n- mkdocstrings:\n handlers:\n python:\n options:\n extensions:\n - griffe_fastapi\n````\n",
"bugtrack_url": null,
"license": null,
"summary": "Griffe extension for FastAPI.",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"griffe",
" griffe-extensions",
" fastapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5cad43accf6fac42dc30c0591353635568094fe4f0cd578e1f9a9e70225ba41",
"md5": "d3b121ca3c7cdbb140ce3b8efd656480",
"sha256": "d53b23d524c7ace0a1f85f477f7b58de995b0834bc440ccd851e758b825626c8"
},
"downloads": -1,
"filename": "griffe_fastapi-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3b121ca3c7cdbb140ce3b8efd656480",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 6166,
"upload_time": "2024-11-22T21:03:31",
"upload_time_iso_8601": "2024-11-22T21:03:31.271165Z",
"url": "https://files.pythonhosted.org/packages/a5/ca/d43accf6fac42dc30c0591353635568094fe4f0cd578e1f9a9e70225ba41/griffe_fastapi-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14a5db1f5bd071959df3d8c27059f067a8fe8ede600d062ecef300d5f9a1c102",
"md5": "8ffbb08a8feeebe7052e8596a83ce54d",
"sha256": "d1534dd0ad9f12e34d66cfce5d797b93129b4d3b174c79fcaeb3d2d1723c71d5"
},
"downloads": -1,
"filename": "griffe_fastapi-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "8ffbb08a8feeebe7052e8596a83ce54d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 4721,
"upload_time": "2024-11-22T21:03:33",
"upload_time_iso_8601": "2024-11-22T21:03:33.476840Z",
"url": "https://files.pythonhosted.org/packages/14/a5/db1f5bd071959df3d8c27059f067a8fe8ede600d062ecef300d5f9a1c102/griffe_fastapi-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 21:03:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "griffe-fastapi"
}
JSON