Cas d'usage des API REST

Name: Cas d'usage des API REST
Author: Josh Guardino

Apprenez à utiliser la documentation OpenAPI et à effectuer des opérations courantes

Preview the first lesson free — get full access to all 4 lessons.

Cours : à la demande

Dans cette leçon, je vais vous montrer comment lire et utilisez la documentation OpenAPI. Il existe plusieurs types de systèmes de documentation pour les API REST mais le plus connu et le plus utilisé s'appelle la spécification OpenAPI. OpenAPI a été introduit pour la première fois par Swagger, qui est un ensemble d'outils API. La norme est maintenant maintenue par un groupe appelé OpenAPI Initiative, qui est un consortium d'experts dans le domaine de la technologie API. L'OpenAPI Initiative publie un cahier des charges qui dicte comment la documentation OpenAPI devrait regarder et fonctionner. Examinons une implémentation de référence d'OpenAPI, qui est hébergé par Swagger. Ça s'appelle l'animalerie Swagger, et c'est un exemple de scénario impliquant des animaux de compagnie, magasins et utilisateurs. Ce format de documentation se veut très simple à lire, complet et avec la capacité pour tester chaque API à partir de la documentation elle-même. Les différentes méthodes HTTP supportées sont codés par couleur. Les requêtes GET sont bleues, Les requêtes POST sont vertes, les requêtes PUT sont orange, et les requêtes DELETE sont rouges. Bien que ces couleurs puissent être personnalisées, ce sont les normes. En cliquant sur chaque endpoint, vous pouvez voir tous des détails de ce point de terminaison particulier dans l'API. Par exemple, les paramètres qui peuvent être transmis à l'API : exemples de corps de requête, types de transfert de documents pris en charge, tels que JSON ou XML, exemples de corps de réponse pour chaque type de code de réponse et les paramètres de requête qui peuvent être transmis à l'API. En outre, au bas d'un document de spécification OpenAPI, vous pouvez trouver les modèles. Celles-ci listeraient les différents types d'objets qui pourrait être inclus dans une réponse du serveur. En cliquant dessus, on peut voir les différents noms d'attributs et types de données. Essayons l'un de ces services. Si on clique sur la requête GET pour trouver des animaux de compagnie par ID, nous pouvons voir qu'il accepte un paramètre, qui est requis appelé petId. C'est un nombre entier, ce qui signifie qu'il doit s'agir d'un nombre entier. Alors cliquons sur le bouton essayer et entrez un ID dans le champ. Cliquons sur exécuter. Et quelques choses arrivent. Tout d'abord, la requête curl est affichée. Curl est un programme en ligne de commande construit dans la plupart des systèmes d'exploitation. Il vous permet d'émettre des requêtes vers tout type de service HTTP en passant une variété d'arguments à l'exécutable curl. Donc, dans ce cas, l'URL OpenAPI spécifiée était /pet/ accolade, petId, accolade fermante. Les noms de variables affichés entre accolades sont destinés à remplacer par les valeurs réelles. Et les points de terminaison de l'API commencent toujours par une barre oblique, qui serait ajouté à l'URL racine de l'API. Comme nous pouvons le voir ici, l'URL racine est https://petstore.swagger.io/v2. La v2 signifie ici la version deux et c'est ainsi que la gestion des versions de l'API est généralement gérée. Le -H représente les en-têtes, et dans ce cas, nous envoyons un simple en-tête d'acceptation, qui indique au serveur quel type du format de document que nous préférerions dans lequel les résultats sont stockés. Ensuite, nous voyons la réponse émise par le serveur. Le code d'état ici est 200, ce qui signifie que la demande a réussi et ce que nous avons ici est un corps de réponse au format JSON et les différents champs sont renseignés avec les valeurs extraites du serveur. Cela représentera alors l'état de cet objet particulier à ce moment précis. Sous le corps de la réponse se trouvent les en-têtes de réponse. Ceci est une méta-information sur la demande qui aide à fournir plus d'informations sur la demande elle-même. Essayons maintenant de tester cette API avec un identifiant d'animal non valide. La documentation OpenAPI est en mesure de valider cela et même pas autoriser la demande à passer. Ainsi, au lieu de mettre une valeur non numérique, mettons un nombre qui est numérique mais est introuvable sur le serveur. Cette fois, notre réponse n'est pas un 200, c'est un 404. 404 est le code d'état HTTP émis lorsqu'une ressource est introuvable. Les diverses autres méthodes HTTP codées par couleur et les terminaux peuvent être utilisés pour transmettre des informations au serveur pour modifier l'état d'un objet. Génération de la documentation OpenAPI est une opération assez simple qui peut être effectuée à partir d'une variété d'outils et de langages de programmation. La documentation OpenAPI n'est généralement pas créée manuellement à la main, mais est généré automatiquement en fonction sur les services qui sont fournis. Par exemple, ce document JSON décrit l'API et ferait partie du code source de l'API. Lorsque l'API est générée, les documents de spécification sont créés automatiquement en fonction sur ce qu'il y a dans ce fichier, faire une documentation complète de n'importe quelle API une opération simple qui restera automatiquement à jour avec des modifications de l'API elle-même. Merci d'avoir regardé. Restez à l'écoute pour la prochaine leçon où je vais vous montrer comment émettre des requêtes GET pour lire l'état d'objets à partir des API REST.

Débutant Fournisseur : Josh Guardino 4 leçons · 24m en Arabe, Allemand, Anglais, Espagnol, Français, Portugais, Chinese

Description du cours

REST est un style d’architecture API qui s’appuie fortement sur les normes de l’industrie ainsi que sur les concepts fondamentaux qui alimentent Internet. Cette approche permet des modèles d’utilisation communs et reproductibles et correspond aux normes largement acceptées pour l’accès aux API et la documentation. De nombreux modules et modèles prêts à l’emploi existent pour les API REST, mais il est également possible, et en fait courant, que les API REST soient créées à partir de zéro.

Il existe de nombreux formats de documentation des API, mais le plus courant et peut-être le plus facile à utiliser s’appelle OpenAPI. Il permet aux propriétaires d’API REST de publier une documentation interactive générée automatiquement en fonction des fonctionnalités de l’API. Vous apprendrez à lire la documentation OpenAPI et à exécuter des tests d’API directement à partir de celle-ci.

Les types les plus courants d’actions d’API et de méthodes HTTP sont couverts, y compris les opérations de lecture à l’aide de la méthode GET, les opérations d’envoi à l’aide de la méthode POST et les méthodes de mise à jour à l’aide des méthodes PUT, PATCH et DELETE.

Ce que vous allez apprendre

Décrire l'objectif et le format de la documentation OpenAPI, y compris comment la lire et exécuter des tests d'API directement à partir d'elle
Lister et décrire les méthodes HTTP les plus courantes utilisées avec les API REST
Effectuer des opérations de lecture en comprenant comment les requêtes GET reçoivent les données des API REST
Envoyer et mettre à jour des données en identifiant comment les requêtes d'écriture (write requests) transmettent les corps de requête (request bodies) aux API REST
Utiliser les requêtes POST pour envoyer des opérations aux API REST
Mettre à jour l'état de l'objet à l'aide des méthodes PUT, PATCH et DELETE

Points clés à retenir

REST est un style architectural d'API qui repose sur les normes de l'industrie et les concepts fondateurs qui animent Internet, permettant des modèles d'utilisation communs et reproductibles.
Les API REST peuvent être construites à l'aide de modules et de modèles (templates) pré-emballés, mais il est également courant de les créer de toutes pièces.
OpenAPI est le format de documentation d'API le plus courant et sans doute le plus facile, et il permet aux propriétaires d'API REST de publier une documentation interactive générée automatiquement en fonction des capacités de l'API.
GET est utilisé pour les opérations de lecture, POST est utilisé pour les opérations d'envoi, et PUT, PATCH et DELETE sont utilisés pour les opérations de mise à jour.
Les requêtes d'écriture envoient des corps de requête aux API REST, tandis que les requêtes GET reçoivent des données de celles-ci.

Foire aux questions

Que couvre ce cours ?

Il couvre le style architectural des API REST, comment lire la documentation OpenAPI et y exécuter des tests d'API, ainsi que les actions d'API et les méthodes HTTP les plus répandues, notamment GET pour les opérations de lecture, POST pour les opérations d'envoi, et PUT, PATCH et DELETE pour les opérations de mise à jour.

Quelles méthodes HTTP vais-je découvrir ?

Le cours aborde les méthodes HTTP les plus courantes, y compris la méthode GET pour lire des données, la méthode POST pour envoyer des données, et les méthodes PUT, PATCH et DELETE pour mettre à jour l'état de l'objet.

Qu'est-ce qu'OpenAPI et comment est-il utilisé dans ce cours ?

OpenAPI est le format de documentation d'API le plus courant, permettant aux propriétaires d'API REST de publier une documentation interactive qui est automatiquement générée en fonction des capacités de l'API. Dans ce cours, vous apprendrez à lire la documentation OpenAPI et à exécuter des tests d'API directement depuis celle-ci.

Quelles leçons sont incluses dans ce cours ?

Le cours comprend quatre leçons : La documentation OpenAPI, Les requêtes GET, Les requêtes POST, et La mise à jour de l'état de l'objet à l'aide des méthodes HTTP.

Quelles compétences ce cours aide-t-il à développer ?

Il soutient des compétences telles que la conception d'API, la gestion d'API, le développement d'API REST, les API RESTful, le client REST et le client REST avancé.