Obux icon indicating copy to clipboard operation
Obux copied to clipboard

Rotas não são RESTful

Open carloscastrodev opened this issue 5 years ago • 1 comments

Problema

As rotas listadas no README estão em desacordo com as recomendações para APIs REST. Veja: https://docs.microsoft.com/pt-br/azure/architecture/best-practices/api-design

Solução proposta

Renomear as rotas de recursos, onde possível, para utilizar apenas substantivos e deixar a semântica da ação realizada a cargo do método HTTP. Por exemplo: (createuser, deluser, updateuser, getuser) -> (user).

Sugestão

Modificar a rota /rateuser para /user/{idUser}/rate Justificativa: a rating de um usuário é um recurso relacionado e que pertence a um usuário.

Sugestão

Modificar a rota de busca /finduser para /user com o método GET, e incluir no README as possíveis query params que a rota aceita (city, state)

Vi o projeto de vocês no Discord da Rocketseat e reparei nisso no README, e gostaria de tentar contribuir um pouco.

carloscastrodev avatar Nov 27 '20 01:11 carloscastrodev

Obrigado por relatar os problemas Carlos. Iremos arrumar assim que possivel. Vlw :D

jonatasfernandespimenta avatar Nov 27 '20 01:11 jonatasfernandespimenta