O que é caminho
Caminho é a parte da URL que identifica o recurso acessado. Em uma API, o caminho aponta o que existe: usuários, pedidos, pets. O restante da URL informa protocolo e domínio.
O caminho é a base da leitura da chamada. Ao olhar para o caminho, dá para entender o que a chamada está acessando. O recurso identificado pelo caminho completa o sentido com o método aplicado.
Caminho e verbo
O caminho identifica o recurso, e o método comunica a ação. A mesma URL com métodos diferentes executa operações diferentes sobre o mesmo recurso. A combinação define a chamada.
Um caminho claro lido junto do verbo comunica a intenção. GET /pets consulta, e POST /pets cria. O caminho aponta o alvo, e o verbo informa o que está sendo feito.
GET /pets → consultar a lista
POST /pets → criar um pet
DELETE /pets/5 → solicitar a remoçãoCaminhos que se aprofundam
O caminho pode ter vários níveis. Um recurso pode conter outros dentro dele. O caminho aninhado comunica a relação entre os recursos, como um pedido dentro de um usuário.
Cada nível adiciona contexto. Um caminho bem desenhado se lê como uma frase. Identificar o recurso, o elemento e a relação ajuda quem consome a API a entender a chamada.
Desenhar o caminho
O bom caminho usa nomes que comunicam o recurso. Palavras claras e hierarquia consistente facilitam a leitura. O padrão seguido pela API torna o caminho previsível.
O caminho autoexplicativo reduz a dependência de documentação. Quem olha para a URL entende o que ela acessa. A organização dos caminhos é parte do desenho da API.
Para desenhar os caminhos da sua API de forma clara, o Desenvolvimento Colaborativo da Dev Side Studio oferece orientação na modelagem dos recursos e das rotas.
Dúvidas frequentes
Perguntas frequentes sobre Caminho
- Caminho e URL são a mesma coisa?
- O caminho é uma parte da URL. A URL inclui também protocolo e domínio. O caminho identifica o recurso dentro do endereço completo.
- O caminho sozinho define o que a chamada faz?
- Não. O caminho identifica o recurso, e o método comunica a ação. A mesma URL com métodos diferentes executa operações diferentes.
- Como desenhar um bom caminho?
- Com nomes que comunicam o recurso e a relação. O caminho bem desenhado se lê e indica o que a chamada faz, antes de consultar a documentação.
- Um caminho pode ter vários níveis?
- Sim. O caminho pode se aprofundar para recursos relacionados, como um pedido dentro de um usuário. Cada nível adiciona contexto à chamada.
Para continuar
Recursos relacionados
Documentação
URL: componentes
As partes que compõem uma URL, incluindo o caminho.
Abrir recursoDocumentação
Desenho de caminhos em APIs
Como organizar caminhos e recursos em uma API.
Abrir recursoAplicação na formação
Developer Workspace
O caminho identifica o recurso na URL e orienta a leitura da chamada.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.