Histórico da Página

...

• 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.

Exemplo de URLs amigáveis

...

• Ordenando e paginando coleções
  • https://totvs.com/api/fluig/fdn/v1/users?order=name,-age&page=2&pageSize=20
• URL com Query Param e nome composto:
  • https://totvs.com/api/fluig/fdn/v1/users/?firstName=joao

Exemplo de URLS NÃO amigáveis e que deve ser evitadas

...