API¶
- Interativa (Swagger):
/api/docs/no sistema em execução. Exige login para os endpoints protegidos. - Especificação OpenAPI: openapi.yaml, gerada automaticamente a partir do código.
Gerado automaticamente
O openapi.yaml é gerado com python manage.py spectacular --file ../docs/referencia/openapi.yaml.
O CI falha se ele estiver diferente do código.
Convenções¶
- Prefixo
/api/; nomes em português (/api/auth/eu/,/api/saude/). - Autenticação por sessão + CSRF (ver Núcleo).
- Erros no formato padrão do Django REST Framework:
{"detail": "mensagem"}.