sexta-feira, 22 de fevereiro de 2013

Web Api

Atualmente estou trabalhando bastante com web api, então estou estudando a melhor forma de trabalhar com essa tecnologia.

Começando do princípio, qual a melhor forma de estruturar nossas rotas ?

A ideia é usar a menor quantidade de rotas diferentes, usando (e abusando) dos verbos HTTP.

Tomando por exemplo uma manipulação de cadastro de pessoas, teremos as seguintes rotas:

  • /people, que manipulará todo o conjunto de pessoas cadastradas no sistema.
  • /people/4261, que manipulará o registro da pessoa de id 4261.
E a partir dessas duas rotas, teremos as ações de listagem, criação, edição e exclusão.

O verbo POST deve ser usado somente para criação de novos registros, para a edição, usa-se o verbo PUT. Para casos de listagem, fazemos um GET, e para remoção, DELETE.

Ilustrando, uma imagem retirada do blog da referência, usando como exemplo a manipulação de cachorros:



* Detalhe: sempre melhor colocar nas rotas um nome no plural, como no exemplo "dogs" ao invés de "dog".

*** Referência: ***
http://blog.apigee.com/detail/restful_api_design_nouns_are_good_verbs_are_bad/

Nenhum comentário:

Postar um comentário