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, sugerimos a utilização do padrão camelCase ou tudo minúsculo separado por hífen.
• Sugerimos utilizar o padrão camelCase ou tudo minúsculo separado por hífen para nome de recursos que contenham mais de uma palavra. Exemplos: orderItem, customerVendor,  customer-vendor etc.
  • Uma vez definido o padrão no XSD ou JsonSchema, obrigatoriamente deve seguir o contratado.

Exemplo de URLs amigáveis

...