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.
Comentário: Uso de camel case para nome de recursos.

...

  • Ao referenciar uma entidade na URL ela deve estar no plural. Ex. /users ao invés de /user;
  • Evite caminhos com mais de 3 parâmetros (além da versão da API), pois isso dificulta a leitura e normalmente indica um problema arquitetural;
  • O caminho deve apontar para um recurso e não para uma ação sobre a entidade, use os verbos HTTP para representar uma ação. Nos casos onde não exista um verbo apropriado a ação pode ser informada como parâmetro no caminho da URL ou na URL.
  • Ao utilizar Query Param com nome composto, é necessário a utilização de camelCase.
  • Utilizar camelCase também para nome de recursos que contenham mais de uma palavra, por exemplo, orderItem, customerVendor, etc.


Exemplo de URLs amigáveis

...