docs: doc guidelines in router template
This commit is contained in:
parent
ff4d36b4cd
commit
f60d86e91d
1 changed files with 13 additions and 0 deletions
|
|
@ -3,6 +3,19 @@ Router endpoints for the <this> module
|
|||
|
||||
Exports:
|
||||
- router: fastapi.APIRouter
|
||||
|
||||
### Router Guidelines ###
|
||||
- Add responses to decorators
|
||||
- Add status_codes to decorators
|
||||
- All endpoints should either return a response object or 204
|
||||
- Ensure response_model is declared in the decorator
|
||||
- All query and path params should have validation and descriptions
|
||||
- All endpoints should have a docstring (this is used in place of a description)
|
||||
- All endpoints should have a summary
|
||||
- All modules should have metadata in main.py
|
||||
- All exceptions should have a custom definition in exceptions.py
|
||||
- Dependencies should be used for db model get and validation where possible
|
||||
- Verify module level docstring is still accurate after updates
|
||||
"""
|
||||
from fastapi import APIRouter
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue