Postman: un outil puissant pour simplifier le développement et les tests d'API

Points clés:

• Postman est un outil puissant qui simplifie les processus de développement et de test des API, fournit des fonctions telles que la sauvegarde des appels API passés et le regroupement des appels d'API associés, ce qui est pratique et rapide.
Les API
• (interface de programmation d'applications) sont généralement créées à l'aide du cadre de repos (transfert d'état dénotatif), qui met en place des directives pour les API basées sur le Web. Les quatre opérations les plus courantes effectuées via l'API consistent, créent, éditent et suppriment des objets.
• Le test API est une partie cruciale du processus de développement pour garantir la fonctionnalité, la gestion des exceptions et la sécurité. Cela peut être fait en utilisant la ligne de commande de la bibliothèque Curl, mais des outils comme Postman peuvent faciliter ce processus.
• Postman peut être utilisé pour envoyer des demandes aux API telles que l'API Graphique Facebook, permettant aux développeurs d'afficher des publications, comme des publications, de créer des publications et de supprimer les publications. Cet outil peut être un atout précieux pour les développeurs utilisant des API.

Grace à Jeff Smith pour son aide, il était enthousiaste à l'idée de participer à l'examen par les pairs de cet article.

Articles populaires sur le site Web SitePoint aujourd'hui:

• Qu'est-ce que HTTP / 2?
• Utilisez ces trois méthodes CSS pour apprivoiser les feuilles de style incontr?lables
• Votre liste de maintenance WordPress ordinaire
• Hébergement du serveur partagé: PROS et CONS
• Pourquoi chaque site Web nécessite-t-il Https

API (interface de programmation d'application) est le moyen d'interaction entre les applications. Les API qui utilisent HTTP ou HTTPS sont appelées API Web.

Si vous regardez sur Internet, vous constaterez qu'un grand nombre de services utilisent des API. Tout service avec la connexion sociale utilise l'API; les applications mobiles pour les sites Web de commerce électronique utilisent l'API; et même les annonces que vous voyez sur Internet utilisent l'API!

En créant des API pour vos services, vous pouvez permettre aux développeurs tiers de créer des applications en fonction de vos services. Par exemple, le site de nouvelles sociales Frrole utilise l'API Twitter pour générer des informations contextuelles en analysant un grand nombre de tweets.

En supposant que vous avez évalué les avantages et les inconvénients de la création d'une API, discutons brièvement du processus de création et de test d'une API.

Créer une API

Bien qu'il existe de nombreuses fa?ons de créer des API, l'API Web est créée à l'aide du framework REST (dénotative State Transfer). Le cadre REST spécifie un ensemble de directives qui doivent être suivies lors de la création d'API. En raison des nombreuses API créées chaque jour, il devient la norme pour les API Web.

Les quatre opérations les plus courantes effectuées via l'API consultent, créent, éditent et suppriment des objets. Le REST Framework mappe quatre verbes HTTP à ces opérations: obtenir, publier, mettre et supprimer. De nombreux verbes sont ajoutés à cette liste, tels que Purge et Patch, mais dans cet article, nous ne discuterons que de quatre verbes de base. Un article sur les meilleures pratiques de l'API RESTful pragmatique écrites par le fondateur d'enching.com, Vinay Sahni, peut être utile pour les développeurs pour la première fois.

De nombreux frameworks fournissent aujourd'hui des emballages pour la couche HTTP de base, ce qui facilite le travail de votre développement. Il vous suffit d'appeler la commande ou la fonction requise et de vous concentrer sur la fonction. Les exemples populaires incluent Slim et Toro, deux cadres miniatures basés sur PHP qui peuvent vous aider à créer rapidement des API REST.

Tester API via CLI

L'objectif principal de la création d'API est de permettre à d'autres applications (probablement la v?tre ou développées par des tiers) d'utiliser ces services. Par conséquent, à chaque étape du processus de développement de l'API, une étape cruciale consiste à tester la fonctionnalité de l'API, la gestion des exceptions et la sécurité de l'API.

L'utilisation d'une API consiste à faire une demande à une ressource souhaitée (généralement une URL) en utilisant l'un des verbes (ou méthodes). Selon les exigences de l'API que vous utilisez, vous devrez peut-être ajouter un en-tête. Une fa?on de demander de telles ressources est la ligne de commande.

Dans cet article, nous nous concentrerons sur quatre parties des appels API - URL, verbe HTTP, en-tête et paramètres. Nous utiliserons la bibliothèque Curl pour envoyer des demandes aux ressources API via la CLI. Curl est un outil de ligne de commande qui aide à transférer les données à l'aide de la syntaxe URL - prend en charge FTP, FTPS, HTTP, HTTPS.

Regardons la commande suivante:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

-i signifie inclure, qui indique à la commande que l'en-tête existe dans la demande. L'option -x suit immédiatement le verbe ou la méthode HTTP. -H spécifie l'en-tête personnalisé ajouté à la demande. Enfin, l'option -D spécifie les données de formulaire personnalisées à passer avec la demande.

est une réponse HTTP, généralement codée au format JSON. La réponse est fournie avec un code de réponse HTTP qui fournit des informations sur l'état de la demande (par exemple, 200 signifie OK, 404 signifie que la ressource n'existe pas, 500 signifie l'erreur du serveur et 403 signifie que la ressource est interdite). Par exemple, la réponse suivante peut être envoyée à la suite d'une demande précédente, ainsi qu'un code d'état de 200:

<code>{"message":"success","id":"4"}</code>

Tester de telles réponses dans la ligne de commande pose également un défi, surtout si la réponse a un grand nombre d'options.

Ce guide détaillé de Codingpedia répertorie la liste des options CLI lors du test de l'API.

Simplifiez les tests avec Postman

Postman est un puissant kit de développement d'API qui rend le processus de développement des API rapidement et facile. Il peut être utilisé comme extension chromée et applications natives pour Mac, Windows et Linux. Plus d'un million de développeurs l'ont essayé. Pour installer des extensions de chrome, vous devez d'abord installer Chrome, puis accéder à la page du projet de la boutique en ligne Chrome.

Comprenons d'abord comment simuler nos demandes de CLI précédentes via Postman. L'image suivante montre la création d'un appel API dans Postman avec les quatre parties discutées ci-dessus:

En plus de l'aper?u (si la réponse est HTML), les réponses que vous recevez via la demande peuvent également être consultées sous forme originale ou magnifique. L'image suivante montre différentes fa?ons de visualiser les réponses dans Postman:

Postman enregistre automatiquement les appels de l'API que vous avez passés dans le passé, ce qui peut gagner du temps lors du test de l'API. De plus, ils peuvent être regroupés en appels d'API associés à votre commodité. Voici un exemple de l'historique des appels API via Postman:

en utilisant l'API du graphique Facebook via Postman

Un bon moyen de démontrer comment fonctionne le facteur est via l'API Facebook Graph. Dans cet article, nous nous concentrerons sur les articles sur la chronologie de l'utilisateur, comment afficher les détails des publications et comment créer et supprimer les publications.

Les jetons d'accès sont cruciaux lors de l'utilisation de l'API graphique. Un jeton est associé à de nombreuses autorisations. Par exemple, vous pouvez créer un article en utilisant un jeton uniquement si Publish_Actions est l'un des champs sélectionnés lors de la génération d'un jeton. Ce niveau de sécurité supplémentaire peut vous aider à accorder des actions spécifiques à une application donnée lors de la connexion via Facebook.

Afficher les messages

Pour envoyer une demande à l'API du graphique, vous devez générer un jeton d'accès. Après avoir généré le jeton, vous devez envoyer une demande GET à l'URL suivante et utiliser Access_token comme paramètre:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

L'image suivante montre l'appel API de graphique de base avec vos coordonnées:

Vous pouvez vérifier la liste des articles sur votre chronologie en suivant la commande:

<code>{"message":"success","id":"4"}</code>

Voici comment les détails de la liste des articles sur votre chronologie peuvent appara?tre:

Pour afficher les détails d'un seul post, utilisez les ressources suivantes:

<code>GET /me/</code>

Les détails d'un seul post sont les suivants:

comme

Pour aimer, envoyez simplement une demande postale à l'URL suivante (veuillez noter que les aime nécessiter Publish_Actions):

<code>GET /me/feed/</code>

Envoyez une demande similaire via Postman comme suit:

De même, vous pouvez supprimer similaire en envoyant une demande de suppression à la même URL:

<code>GET /post-id/</code>

Créer un post

Pour créer un article, vous devez envoyer certains paramètres en plus de la demande de publication. Vous avez également besoin de publier_actions pour ce faire.

Vous pouvez ajouter les options suivantes à votre demande de message:

• Message: Message associé au post
• lien: lien vers les ressources externes
• Place: l'emplacement associé à la publication (similaire à "enregistrer" un emplacement)
• Tags: tout ami ou page
• Confidentialité: le public pour les publications à visible
• objet_attachment: toute publication Facebook existante

La documentation explique comment toutes ces fonctions sont utilisées.

Vous pouvez créer des publications sur votre propre calendrier ou sur la chronologie des utilisateurs, pages, événements ou groupes en fonction de l'URL que vous choisissez d'envoyer la demande:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

Essayons de publier sur notre propre calendrier. Si la demande réussit, nous obtiendrons l'ID de la publication créée. Voici un exemple de création d'un nouveau post à l'aide de l'API Graphique:

Pour modifier un article, vous devez envoyer une demande de publication (pas mettre) à l'URL suivante et utiliser les mêmes paramètres que vous le feriez lorsque vous créez un message:

<code>{"message":"success","id":"4"}</code>

supprimer les messages

Comme la suppression d'un Like, la suppression d'un message vous oblige à envoyer une demande de suppression à l'URL du post:

<code>GET /me/</code>

Remarque: Nous avons vu dans cet article que Postman a de nombreuses fonctionnalités utiles. Après la mise à niveau de la version gratuite (9,99 $ par licence), il y a plus de fonctionnalités - comme l'exécution des collections d'API sur plusieurs valeurs de données.

Conclusion

La création d'une API est une tache cruciale, impliquant de nombreuses étapes importantes. Postman facilite le processus de test approfondi. Actuellement, Postman semble bien résoudre le problème du développeur moyen. Cependant, comment il évolue avec les changements de paradigme couramment trouvés dans l'industrie du Web reste à voir.

manquons-nous les caractéristiques importantes de Postman? Utilisez-vous un autre client pour tester l'API? Veuillez nous faire savoir dans les commentaires ci-dessous.

Les questions fréquemment posées sur la construction et le test des API avec Postman

Qu'est-ce que Postman et comment cela aide-t-il à construire et à tester les API?

Postman est un outil populaire pour les développeurs pour construire et tester les API. Il fournit une interface conviviale qui permet d'envoyer des demandes HTTP faciles et de visualiser les réponses. Postman prend en charge divers types de demandes HTTP, telles que Get, Post, Supprimer, Put, etc. Il vous permet également d'économiser des demandes et de les organiser dans une collection pour un accès et un partage faciles. Les fonctionnalités de test intégrées de Postman vous permettent d'écrire des tests pour votre API directement dans l'outil lui-même, ce qui en fait une solution complète pour le développement de l'API.

est-il libre de facteur?

Postman propose des versions gratuites et payantes. La version gratuite, appelée Postman Basic, offre un ensemble puissant de fonctionnalités qui sont suffisantes pour répondre aux besoins des développeurs individuels ou de petites équipes. Pour les grandes équipes ou les entreprises qui nécessitent des fonctionnalités avancées et des capacités de collaboration, Postman propose un plan payant.

En quoi Postman Pro est-il différent de la version de base?

Postman Pro est une version payante qui offre des fonctionnalités supplémentaires que l'on trouve dans la version de base. Il s'agit notamment de la collaboration d'équipe, de la surveillance des API, de la documentation avancée de l'API, etc. Il est con?u pour les développeurs professionnels et les équipes qui ont besoin de gérer des projets de développement API complexes.

Comment acheter Postman?

Vous pouvez acheter Postman sur leur site officiel. Ils offrent différents plans de prix en fonction de la taille de votre équipe et des besoins spécifiques. Vous pouvez choisir un plan qui répond à vos besoins et suivre les invites pour terminer l'achat.

Quel est le r?le du facteur dans le développement de logiciels?

Dans le développement de logiciels, Postman joue un r?le crucial dans le développement et les tests d'API. Il permet aux développeurs de construire, tester et documenter les API sur une seule plate-forme, simplifiant ainsi le processus de développement. Il soutient également la collaboration, ce qui permet aux équipes de travailler plus facilement sur des projets API ensemble.

Puis-je utiliser Postman pour des tests automatisés?

Oui, Postman prend en charge les tests automatisés. Vous pouvez rédiger des tests pour votre API dans Postman et les exécuter automatiquement à l'aide de la collection Runner de Postman ou Newman (outil de ligne de commande de Postman). Cela facilite l'intégration des tests d'API dans votre pipeline d'intégration continue / livraison continue (CI / CD).

Comment organiser mes demandes d'API dans Postman?

Postman vous permet d'organiser les demandes d'API dans les collections. Une collection est un ensemble de demandes connexes qui peuvent être enregistrées ensemble. Cela facilite la gestion et le partage de vos demandes. Vous pouvez également ajouter des dossiers à la collection pour une nouvelle organisation.

Postman prend-il en charge différents types d'authentification?

Oui, Postman prend en charge divers types d'authentification, y compris l'authentification de base, le jeton de porteurs, l'OAuth 1.0, l'OAuth 2.0, et plus encore. Cela en fait un outil polyvalent pour tester les API avec différentes exigences d'authentification.

Puis-je partager ma collection Postman avec les autres?

Oui, Postman vous permet de partager votre collection avec les autres. Ceci est particulièrement utile pour le travail d'équipe. Si vous utilisez une version payante, vous pouvez partager la collection en l'exportant en tant que fichier JSON ou partageant directement à partir de Postman.

Comment apprendre à utiliser efficacement Postman?

Il existe de nombreuses ressources pour apprendre le facteur. Le site Web officiel de Postman fournit une documentation complète et des tutoriels. Il existe également de nombreux cours en ligne, blogs et forums où vous pouvez apprendre les expériences d'autres utilisateurs de facteurs.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!