{"id":20814352,"url":"https://github.com/fbraem/griffe-fastapi","last_synced_at":"2026-05-05T01:32:07.037Z","repository":{"id":263165301,"uuid":"889172254","full_name":"fbraem/griffe-fastapi","owner":"fbraem","description":"Griffe extension for FastAPI","archived":false,"fork":false,"pushed_at":"2024-12-07T14:54:18.000Z","size":20,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-18T15:30:46.685Z","etag":null,"topics":["fastapi","griffe-extension","mkdocs","mkdocstrings"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fbraem.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-15T18:48:55.000Z","updated_at":"2024-12-07T14:54:21.000Z","dependencies_parsed_at":"2024-11-16T17:26:28.990Z","dependency_job_id":"4ac490d8-9bce-4af5-9d3d-b0330e712b89","html_url":"https://github.com/fbraem/griffe-fastapi","commit_stats":null,"previous_names":["fbraem/griffe-fastapi"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbraem%2Fgriffe-fastapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbraem%2Fgriffe-fastapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbraem%2Fgriffe-fastapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbraem%2Fgriffe-fastapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fbraem","download_url":"https://codeload.github.com/fbraem/griffe-fastapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243159166,"owners_count":20245675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastapi","griffe-extension","mkdocs","mkdocstrings"],"created_at":"2024-11-17T21:15:48.875Z","updated_at":"2025-12-27T04:05:08.476Z","avatar_url":"https://github.com/fbraem.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"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\nConfiguration\n-------------\n\n+ **paths** select only apply griffe-fastapi for the given paths\n+ **generate_table** Add a table in the docstring with the http response codes (default=True)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbraem%2Fgriffe-fastapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffbraem%2Fgriffe-fastapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbraem%2Fgriffe-fastapi/lists"}