book

Livre de recettes sur les pratiques et les modèles d'API Web RESTful

by Mike Amundsen

November 2024

Intermediate to advanced

470 pages

13h 20m

French

O'Reilly Media, Inc.

Book available

Read now

Unlock full access

À propos de ce livreConventions utilisées dans ce livreUtiliser des exemples de codeApprentissage en ligne O'ReillyComment nous contacterRemerciements
Que sont les API Web RESTful ?Pourquoi l'hypermédia ?Principes partagés pour des services évolutifs sur le Web
Établir une base avec des conceptions hypermédiasAugmenter la résilience avec les clients hypermédiasPromouvoir la stabilité et la modifiabilité avec lesservices hypermédiasPrise en charge des données distribuéesFavoriser l'extensibilité avec le flux de travail hypermédia
3.1. Créer l'interopérabilité avec les types de médias enregistrés3.2. Assurer la compatibilité future avec lestypes de médias structurés3.3. Partage des spécificités d'un domaine par le biais de vocabulaires publiés3.4. Décrire les espaces de problèmes à l'aide de profils sémantiques3.5. Exprimer des actions au moment de l'exécution avec des hypermédias intégrés3.6. Conception d'écritures de données cohérentes avec desactions idempotentes3.7. Permettre l'interopérabilité grâce auxtransferts d'état entre services3.8. Concevoir des actions répétables3.9. Concevoir des actions réversibles3.10. Conception de messages extensibles3.11. Conception d'interfaces modifiables
4.1. Limiter l'utilisation d'URL codées en dur4.2. Coder les clients pour qu'ils soient conscients de l'existence du protocole HTTP4.3. Coder des clients résilients avec des implémentations centrées sur les messages4.4. Codage des clients efficaces pour comprendre lesprofils de vocabulaire4.5. Négociation de la prise en charge du profil au moment de l'exécution4.6. Gestion des formats de représentation au moment de l'exécution4.7. Utilisation des documents de schéma comme source demétadonnées de message4.8. Chaque élément important d'une réponsea besoin d'un identifiant4.9. S'appuyer sur les contrôles hypermédias dans la réponse4.10. Liens et formulaires de soutien pour lesservices non hypermédias4.11. Validation des propriétés des données au moment de l'exécution4.12. Utilisation des schémas de documents pour valider lesmessages sortants4.13. Utilisation des requêtes documentaires pour valider lesmessages entrants4.14. Validation des données entrantes4.15. Gestion de ton propre état4.16. Avoir un objectif en tête
5.1. Publier au moins une URL stable5.2. Prévenir les fuites du modèle interne5.3. Conversion des modèles internes en messages externes5.4. Exprimer les fonctions internes comme des actions externes5.5. Soutien publicitaire aux préférences de réponse des clients5.6. Prise en charge de la négociation de contenu HTTP5.7. Publication de vocabulaires complets pour les clients de la machine5.8. Prise en charge des vocabulaires partagés dans des formats standard5.9. Publication des documents de définition des services5.10. Publication des métadonnées de l'API5.11. Soutien à la surveillance de la santé des services5.12. Normaliser les rapports d'erreurs5.13. Améliorer la découvrabilité des services grâce à un registre de services en cours d'exécution5.14. Augmentation du débit avec des identificateurs fournis par le client5.15. Améliorer la fiabilité avec la création idempotente5.16. Fournir des replis d'exécution pour les services dépendants5.17. Utilisation de mandataires sémantiques pour accéder à desservices non conformes
6.1. Cacher les éléments internes de ton stockage de données6.2. Rendre tous les changements idempotents6.3. Masquer les relations de données pour les actions externes6.4. Exploiter les URL HTTP pour prendre en charge les requêtes "Contains" et "AND". et "AND6.5. Renvoi des métadonnées pour les réponses aux requêtes6.6. Retour de HTTP 200 ou HTTP 400 pour lesrequêtes centrées sur les données6.7. Utilisation des types de médias pour les requêtes de données6.8. Ignorer les champs de données inconnus6.9. Améliorer les performances avec les directives de mise en cache6.10. Modifier les modèles de données en production6.11. Extension des magasins de données distants6.12. Limiter les réponses à grande échelle6.13. Utilisation de mandataires pour l'échange de données

7.1. Concevoir des services compatibles avec le flux de travail7.2. Prise en charge de l'état partagé pour les flux de travail7.3. Décrire le flux de travail sous forme de code7.4. Description du flux de travail en tant que DSL7.5. Décrire le flux de travail sous forme de documents7.6. Prise en charge du langage de contrôle des tâches RESTful7.7. Exposer une ressource de progression pour tes flux de travail7.8. Retourner toutes les actions connexes7.9. Retourner les ressources les plus récemment utilisées7.10. Prise en charge du travail en cours avec état7.11. Activation de la navigation par liste standard7.12. Soumission d'un formulaire partiel à l'appui7.13. Utilisation de State-Watch pour permettre un flux de travail piloté par le client7.14. Optimisation des requêtes avec des relectures stockées7.15. Réponse synchrone pour travail incompletavec 202 accepté7.16. Corrections à court terme avec tentatives automatiques7.17. Prise en charge de l'annulation ou du retour en arrière local7.18. Appeler à l'aide7.19. Mise à l'échelle du flux de travail avec les files d'attente et les grappes7.20. Utilisation des mandataires de flux de travail pour enrôler desservices non conformes
Appliquer ces recettesTransformer les services existantsRessources supplémentairesProchaines étapes
Types de médias enregistrés viables pour les API Web RESTfulFormats de définition de l'APIFormats des documents du profil sémantiqueTypes de supports hypermédias
Bonjour, Hyper !Autres informations

Content preview from Livre de recettes sur les pratiques et les modèles d'API Web RESTful

Chapitre 1. Présentation des API Web RESTful

Cet ouvrage a été traduit à l'aide de l'IA. Tes réactions et tes commentaires sont les bienvenus : translation-feedback@oreilly.com

Tire parti de la portée mondiale pour résoudre des problèmes auxquels tu n'as pas pensé pour des personnes que tu n'as jamais rencontrées.

Le principe des API web RESTful

Dans la préface, j'ai mentionné le titre à la mode de ce livre comme un point d'intérêt. C'est ici que nous allons explorer la pensée qui sous-tend les API Web RESTful et pourquoi je pense qu'il est important d'utiliser ce type de dénomination et de comprendre la signification qui se cache derrière.

Pour commencer, je vais vous expliquer ce que signifie l'expression "RESTful web APIs" et pourquoi j'ai opté pour ce qui semble être un terme à la mode. Ensuite, nous passerons un peu de temps sur ce que j'estime être la technologie clé qui peut alimenter des services résilients et fiables sur le Web ouvert - l'hypermédia. Enfin, une courte section explore un ensemble de principes partagés pour la mise en œuvre et l'utilisation d'interfaces de services basées sur REST - quelque chose qui guide la sélection et la description des modèles et des recettes dans ce livre.

Les implémentations hypermédias reposent sur trois éléments clés : les messages, les actions et les vocabulaires (voir la figure 1-1). Dans les solutions basées sur les hypermédias, les messages sont transmis à l'aide de formats courants tels que HTML, Collection+JSON et SIREN. ...