Serviços da Web RESTful - Endereçamento
O endereçamento refere-se à localização de um recurso ou vários recursos no servidor. É análogo localizar o endereço postal de uma pessoa.
Cada recurso na arquitetura REST é identificado por seu URI (Uniform Resource Identifier). Um URI tem o seguinte formato -
<protocol>://<service-name>/<ResourceType>/<ResourceID>O objetivo de um URI é localizar um ou mais recursos no servidor que hospeda o serviço da web. Outro atributo importante de uma solicitação é VERB, que identifica a operação a ser executada no recurso. Por exemplo, no capítulo RESTful Web Services - Primeiro aplicativo , o URI éhttp://localhost:8080/UserManagement/rest/UserService/users e o VERBO é GET.
Construindo um URI padrão
A seguir estão os pontos importantes a serem considerados ao projetar um URI -
Use Plural Noun- Use o substantivo plural para definir recursos. Por exemplo, usamos usuários para identificar usuários como um recurso.
Avoid using spaces- Use sublinhado (_) ou hífen (-) ao usar um nome de recurso longo. Por exemplo, use authorized_users em vez de% 20users autorizados.
Use lowercase letters - Embora o URI não faça distinção entre maiúsculas e minúsculas, é uma boa prática manter o url apenas em letras minúsculas.
Maintain Backward Compatibility- Como o Web Service é um serviço público, um URI, uma vez tornado público, deve estar sempre disponível. Caso o URI seja atualizado, redirecione o URI mais antigo para um novo URI usando o código de status HTTP, 300.
Use HTTP Verb- Sempre use HTTP Verb como GET, PUT e DELETE para fazer as operações no recurso. Não é bom usar o nome de operações no URI.
Exemplo
A seguir está um exemplo de um URI ruim para buscar um usuário.
http://localhost:8080/UserManagement/rest/UserService/getUser/1A seguir está um exemplo de um bom URI para buscar um usuário.
http://localhost:8080/UserManagement/rest/UserService/users/1