Documentação oficial — ecosif-auth
Serviço de autenticação eCosif. Pasta canônica: docs/ (EC-011).
Estrutura por público
| Pasta | Público | Conteúdo |
|---|---|---|
| architecture/ | Desenvolvedores | Camadas, fluxos JWT |
| dev/ | Desenvolvedores / integradores | Setup, testes, OpenAPI, external-login |
| deploy/ | Ops / SRE | Docker, AWS, runbooks Azure/Google |
| user/ | Negócio / PO | Casos de uso, regras, visão geral |
| client/ | Stakeholders | Resumo não técnico |
| release-notes/ | Todos | Pen test, alinhamento OpenAPI |
Início rápido
| Público | Comece por |
|---|---|
| Desenvolvedor | dev/como_rodar_localmente.md |
| Integrador | dev/integradores/external-login-api.md |
| DevOps | deploy/runbook_azure_entra.md · deploy/docker.md |
| Arquitetura | architecture/arquitetura.md |
API
- Lista: dev/endpoints/lista_endpoints.md
- OpenAPI: dev/endpoints/openapi.yaml
- Runtime:
/swagger-ui.html·/v3/api-docs
Exemplos e legado
- YAML de mapping: dev/examples/
- Legado: legacy/old-docs/ (fora do Pages)
Publicação
GitHub Pages no push para develop (fonte: docs/, exclui legacy/).