...
Deck of Cards |
---|
|
Card |
---|
| Padrão de nomenclatura http://{{host}}/api/{{agrupador}}/{{versão}}/{{recurso}}
- Dê preferência para o plural ao disponibilizar o resource. Utilize
/users ao invés de /user . - Dê preferência para URL's em minúsculo, evite
GET /Users , use GET /users . - U
A raiz do resource deve retornar uma coleção. Por exemplo /users deve retornar um lista de usuários. Se desejar obter um resource especifico utilize o nível seguinte especificando seu identificador único. GET /users/2 . Não precisa ser o id do banco, poderia ser outro campo, desde que seja identificador único. Um usuário poderia ser o username. GET /users -> Retorna uma lista de usuáriosGET /users/bruno -> Retorna o usuário com username brunoPOST /users -> Cria um usuárioPUT /users/bruno -> Atualiza o usuário brunoPATCH /users/bruno -> Atualiza parcialmente o usuário brunoDELETE /users/bruno -> Remove o usuário bruno
Relacionamento filho - Se existir alguma tabela filho do resource, eles devem estar mapeados para o mesmo endpoint. Exemplo GET /users/bruno/claims -> Retorna uma lista de claims do usuário brunoGET /users/bruno/claims/6 -> Retorna o claims com Id 6POST /users/bruno/claims -> Cria uma claim para usuário brunoPUT /users/bruno/claims/6 -> Atualiza a claim 6 do usuário brunoPATCH /users/bruno/claims/6 -> Atualiza parcialmente a claim 6 do usuário brunoDELETE /users/bruno/claims/6 -> Remove a claim 6 do usuário bruno
|
|
Fontes:
https://api.totvs.com.br/guia
https://blog.geekhunter.com.br/sua-api-nao-e-restful-entenda-por-que/
...