cloud-api/src/_module_template/router.py

26 lines
797 B
Python
Raw Normal View History

2026-04-06 12:41:49 +01:00
"""
2026-05-28 15:41:10 +01:00
Router endpoints for the <this> module
2026-04-06 12:41:49 +01:00
2026-05-28 15:41:10 +01:00
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
2026-04-06 12:41:49 +01:00
"""
from fastapi import APIRouter
2026-05-28 15:41:10 +01:00
router = APIRouter(
2026-04-06 12:41:49 +01:00
tags=[""],
2026-05-28 15:41:10 +01:00
)