O que é um ID de recurso
ID de recurso é o identificador que aponta para um elemento específico dentro de um recurso. Enquanto o recurso representa o conjunto, o ID seleciona um elemento: /pets é o conjunto, e /pets/5 é o pet de ID 5.
O ID aparece no caminho da chamada e define qual elemento a operação atinge. Sem o ID, a chamada se refere ao conjunto. Com o ID, ela se refere a um elemento específico dentro dele.
ID e exclusividade
O ID precisa distinguir os elementos de um recurso. Cada elemento tem um identificador que o diferencia dos outros. A exclusividade do ID é parte do desenho do recurso.
O formato do ID varia conforme a aplicação. Pode ser numérico, textual ou outro tipo. O importante é que identifique o elemento de forma única dentro do recurso.
GET /pets → consultar a lista
GET /pets/5 → consultar o pet de ID 5
DELETE /pets/5 → solicitar a remoção do pet 5ID e autorização
O ID aponta o alvo, e a autorização controla o acesso. O usuário pode mudar o número no caminho e tentar acessar um elemento que não é dele. A permissão precisa validar a propriedade antes de executar.
Quando o recurso pertence a um contexto, o caminho pode incluir a relação. O ID identifica o elemento, e a verificação confirma se ele pertence ao usuário da chamada. O acesso indevido é bloqueado na autorização.
ID e relação entre recursos
O ID também conecta recursos. Um sub-recurso aparece dentro do contexto de outro, usando o ID para referenciar o elemento pai. O caminho comunica a relação.
A modelagem dos IDs acompanha a realidade do domínio. Um pedido pertence a um usuário, e uma negociação pertence a um contato. O identificador e o contexto no caminho descrevem a relação entre os recursos.
Para modelar os IDs e as relações da sua API com segurança, o Desenvolvimento Colaborativo da Dev Side Studio oferece orientação na organização e na autorização das chamadas.
Dúvidas frequentes
Perguntas frequentes sobre ID de recurso
- ID de recurso é o mesmo que chave primária?
- São próximos. A chave primária é o identificador no banco. O ID de recurso é como a API identifica o elemento no caminho. Um pode se apoiar no outro.
- O ID precisa ser um número?
- Não. Pode ser numérico, textual ou outro formato, conforme o desenho da aplicação. O importante é que identifique o elemento de forma única.
- Dois recursos podem ter o mesmo ID?
- No mesmo recurso, não. O ID precisa distinguir os elementos. Em recursos diferentes, cada conjunto tem seus próprios identificadores.
- O usuário pode mudar o ID no caminho?
- Pode tentar. Por isso, a autorização precisa validar se o elemento identificado pertence a quem acessa. O ID aponta o alvo, e a permissão controla o acesso.
Para continuar
Recursos relacionados
Documentação
Modelagem de recursos com identificadores
Como identificar recursos e elementos em uma API.
Abrir recursoDocumentação
REST: recursos na MDN
O papel da URL e do identificador na organização dos recursos.
Abrir recursoAplicação na formação
Developer Workspace
O ID de recurso identifica um elemento específico dentro do recurso acessado pela API.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.