- Mantenha a consistência: URL/headers/autenticação/códigos de status..
- Use o formato de data ISO8601 em UTC
- Exceção de autenticação apenas para endpoints públicos. Todos os demais exigem autenticação
- Forneça um endpoint de health check
- Versionamento de API
- Aplique autenticação por chave de API
- Use métodos HTTP e códigos de status adequados e razoáveis
- Use nomes simples e autoexplicativos para cada endpoint
- Use respostas de erro padronizadas
- Retorne o recurso criado no POST
- PATCH em vez de PUT
- Seja o mais específico possível
- Use paginação
- Torne cada recurso expansível (projete para também poder retornar informações adicionais com query params como
expand)
2 comentários
Tenho visto muito conteúdo relacionado por aí ultimamente, e recomendo "Web API Design". Pelo título e pela capa, dá para confundir com um livro de analogias fáceis sobre a internet no dia a dia, mas é uma ótima obra em que se destaca a percepção do autor sobre design de API, já que ele trabalha profissionalmente com isso.
Diretrizes de API REST da Microsoft
Diretrizes de API REST do Stack Overflow