Páginas filhas
  • Guia de implementacao das APIs TOTVS

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Informações
titleImportante

Os campos do JSON que representam data DEVEM usar os formato definido no documento ISO-8601 no formato EXTENDIDO.

 

Mensagens de erro

Para todas as mensagens que representam um erro (códigos HTTP 4xx e 5xx) deve-se retornar obrigatoriamente os campos a seguir:

...


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

Tem que sair com swagger (json e 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.