REST API
API REST
Une API REST est une interface HTTP construite autour de ressources, telles que des commandes ou des utilisateurs. Chaque requête est autonome, utilise les significations HTTP standard, peut prendre en charge la mise en cache et peut passer par des couches.
Un autre exemple
Une application d'entrepôt récupère `/orders/784`, change son adresse avec un `PATCH` conditionnel, et suit un en-tête `Link` vers le suivi. Tout serveur sans état peut gérer la requête. Si le `ETag` est ancien, le serveur renvoie 412 au lieu de remplacer une modification plus récente.
Parties principales
- 01Identifiant de ressource
- 02Opération HTTP uniforme
- 03Représentation et liens
Utilisez-le lorsque
Utilisez REST lorsque les ressources HTTP, la mise en cache, les couches intermédiaires et les clients qui peuvent évoluer indépendamment correspondent au produit.
Ne l'utilisez pas lorsque
Une API n’est pas RESTful juste parce qu’elle envoie du JSON via HTTP. Les sessions avec état, les tunnels de commandes RPC ou l’ignorance des significations HTTP sont des conceptions différentes.
Nom utilisé dans le code
client-server + stateless + cache + uniform interface + layered system + hypermedia Avant d'expédier
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: Une application d'entrepôt récupère `/orders/784`, change son adresse avec un `PATCH` conditionnel, et suit un en-tête `Link` vers le suivi. Tout serveur sans état peut gérer la requête. Si le `ETag` est ancien, le serveur renvoie 412 au lieu de remplacer une modification plus récente. Technical concept or control: API REST (REST API). Why it fits: Utilisez REST lorsque les ressources HTTP, la mise en cache, les couches intermédiaires et les clients qui peuvent évoluer indépendamment correspondent au produit. Do not use it when: Une API n’est pas RESTful juste parce qu’elle envoie du JSON via HTTP. Les sessions avec état, les tunnels de commandes RPC ou l’ignorance des significations HTTP sont des conceptions différentes. 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): Aucun standard officiel unique ne régit l’ensemble du terme. Sa signification peut varier selon les équipes, plateformes 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.
Vérifiez cette demande
Review how API REST (REST API) is used now. Definition: Une API REST est une interface HTTP construite autour de ressources, telles que des commandes ou des utilisateurs. Chaque requête est autonome, utilise les significations HTTP standard, peut prendre en charge la mise en cache et peut passer par des couches. 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.