Definições
Critérios de aceitação
O Gov.pi Conecta, que provê os serviços desenvolvidos por órgãos parceiros, adota uma escala própria de avaliação de 0 a 100 pontos.
Para que uma API seja aceita, é necessário atingir pelo menos 80 pontos.
| Critério | Pontuação (pts) | Descrição |
|---|---|---|
| Protocolo HTTP: Padronização das rotas | 5 | Utilizar padrão único definido para todos os endpoints |
| Protocolo HTTP: Verbos HTTP ao invés de operações | 5 | Usar corretamente os verbos, evitando substantivos para descrever ações |
| Protocolo HTTP: Paths curtos | 10 | Evitar o uso de rotas muito extensas |
| Protocolo HTTP: Padronização dos códigos de resposta | 5 | Utilizar uma padronização mínima para códigos HTTP |
| Versionamento | 5 | Definir versão nas rotas da API, e não apenas no código |
| Stateless | - | A API não deve guardar estados de comunicação |
| Autenticação | 5 | Utilizar padrões seguros e modernos de autenticação |
| Documentação aberta | 10 | Disponibilizar documentação clara (preferencialmente com Swagger/OpenAPI) |
| Aceitar e responder em JSON | 5 | Trafegar dados em JSON nas requisições e respostas |
| Página de healthcheck | 10 | Possuir endpoint de verificação de disponibilidade da API |
| Aninhamento de recursos | 10 | Utilizar corretamente recursos aninhados |
| Dados em cache | 10 | Implementar cache para melhorar performance |
| Filtragem, ordenação e paginação | 10 | Permitir que a API ofereça esses recursos quando aplicável |
| Boas práticas de segurança | 10 | Seguir as recomendações de segurança documentadas |
| Pontuação total | 100 | — |