juggl/backend/docs/guidelines.md
2021-12-21 22:45:28 +01:00

11 lines
No EOL
461 B
Markdown

# Guidelines
Guidelines we want and should follow for Juggl API.
---
- All routes and should be `async` for maximum performance
- All routes should specify a `response_model` in the route decorator if they return anything. The same type should
be used as type hint for the function return type. FastAPI is unfortunately not yet smart enough to determine the
`response_model` from the return type hint. Maybe we should consider making a pull request...