REST API
API REST
Uma API REST é uma interface HTTP construída em torno de recursos, como pedidos ou usuários. Cada requisição é independente, utiliza significados padrão do HTTP, pode suportar cache e pode passar por camadas.
Outro exemplo
Um aplicativo de armazém obtém `/orders/784`, altera seu endereço com um `PATCH` condicional e segue um cabeçalho `Link` até o rastreamento. Qualquer servidor sem estado pode processar a solicitação. Se o `ETag` estiver antigo, o servidor retorna 412 em vez de substituir uma edição mais recente.
Partes principais
- 01Identificador de recurso
- 02Operação HTTP uniforme
- 03Representação e links
Use-o quando
Use REST quando HTTP baseado em recursos, cache, camadas intermediárias e clientes que podem mudar por conta própria se ajustarem ao produto.
Não o use quando
Uma API não é RESTful apenas porque envia JSON via HTTP. Sessões com estado, túneis de comando RPC ou significados HTTP ignorados são designs diferentes.
Nome usado no código
client-server + stateless + cache + uniform interface + layered system + hypermedia Antes de lançar
Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback.
Outcome: Complete the task with API REST (REST API). User context: Um aplicativo de armazém obtém `/orders/784`, altera seu endereço com um `PATCH` condicional e segue um cabeçalho `Link` até o rastreamento. Qualquer servidor sem estado pode processar a solicitação. Se o `ETag` estiver antigo, o servidor retorna 412 em vez de substituir uma edição mais recente. Technical concept or control: API REST (REST API). Why it fits: Use REST quando HTTP baseado em recursos, cache, camadas intermediárias e clientes que podem mudar por conta própria se ajustarem ao produto. Do not use it when: Uma API não é RESTful apenas porque envia JSON via HTTP. Sessões com estado, túneis de comando RPC ou significados HTTP ignorados são designs diferentes. Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary): Nenhum padrão oficial único controla todo o termo. Seu significado pode mudar entre equipes, plataformas ou frameworks. Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.
Conferir este pedido
Review how API REST (REST API) is used now. Definition: Uma API REST é uma interface HTTP construída em torno de recursos, como pedidos ou usuários. Cada requisição é independente, utiliza significados padrão do HTTP, pode suportar cache e pode passar por camadas. Release checks: Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback. Before changing code, list the evidence, gaps, severity, and the smallest safe fix.