File: fastapi.md

package info (click to toggle)
python-griffe 1.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,256 kB
  • sloc: python: 16,348; javascript: 84; makefile: 47; sh: 24
file content (16 lines) | stat: -rw-r--r-- 541 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# `griffe-fastapi`

- **PyPI**: [`griffe-fastapi`](https://pypi.org/project/griffe-fastapi/)
- **GitHub**: [fbraem/griffe-fastapi](https://github.com/fbraem/griffe-fastapi)
- **Extension name:** `griffe_fastapi`

---

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 then rendered with a custom mkdocstrings template provided by the extension.