Histórico da Página
...
Nos casos em que o resultado da operação do endpoint represente uma coleção além do campo content deve ser retornado o campo , os itens devem estar agrupados em um objeto com as propriedades hasNext, indicando se existe uma próxima página com mais registros para aquela coleção e items que representa a lista de itens retornados.
| Bloco de código | ||
|---|---|---|
| ||
{ content: { hasNext: true, content items: [ {}, {}, ... ] } } |
Código 4xx versus 5xx
Dividimos os erros em duas categorias: Erros de negócio ou requisição e Erros não esperados.
...
Versionamento
- API interna deve seguir esse padrão, mas é independe do versionamento. Deve estar documentado (tecnica) para as novas.
- Validar como passar a versão URL ou header. Testar com o Paulo.
Dicas de como implementar os métodos para tentar manter um padrão de implementação.
Documentação
Todas os métodos, parâmetros, códigos de erro e mensagens de requisição e retorno da API publica DEVEM estar documentadas na página de documentação do fluig. Além disso DEVE ser gerado um documento SWAGGER com as definições da API.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas