OpenAPI

OpenAPI est une spécification standard de l'industrie pour décrire les API. Nous utilisons OpenAPI pour pour décrire toutes nos API, et nous mettons également ces spécifications à la disposition du public.

Trouver une spécification OpenAPI

Chacun de nos produits possède sa propre spécification OpenAPI. Le moyen le plus simple de la trouver est de consulter la référence de l'API. en haut de la page, vous trouverez "Download OpenAPI Specification", qui vous permettra de télécharger la référence API. Les pages de référence de l'API sont elles-mêmes générées à partir de ces spécifications.

Chaque spécification est disponible à la fois en YAML et JSON Vous pouvez les visualiser à l'aide d'un éditeur de texte simple.

Utiliser une spécification OpenAPI dans vos propres projets

Disposer de la description OpenAPI d'une API avec laquelle vous souhaitez vous intégrer peut vraiment faciliter les choses ! Voici quelques suggestions que vous pourriez essayer :

Documentation locale

Que vous travailliez avec une mauvaise connexion ou que vous préfériez garder les choses simples, une spécification OpenAPI contient toutes les informations dont vous avez besoin pour pouvoir exécuter une application locale afin de montrer la documentation. ReDoc est un exemple d'outil de documentation open source que vous pouvez utiliser pour consulter la spécification de l'API.

Collections du facteur

Si vous êtes déjà un Facteur alors il pourrait bien vous plaire. Si ce n'est pas le cas, essayez-le. d'essayer.

1. Télécharger la spécification de l'API qui vous intéresse (via la page de référence de l'API)
2. Dans Postman, cliquez sur "Importer" et choisissez le fichier *.yml fichier que vous avez téléchargé

...., c'est tout. Vous disposez d'un ensemble de requêtes prêtes à l'emploi pour l'API. Ajoutez les détails de votre Account Vonage et c'est parti ! et c'est parti !

Serveur fictif pour les tests avec Prism

Un outil que beaucoup de nos développeurs trouvent utile est Prisme. Il s'agit d'un outil JavaScript JavaScript open source qui accepte une spécification OpenAPI et imite ensuite le comportement de l'API qu'elle décrit. C'est un moyen idéal de travailler avec une API locale, évite d'utiliser du crédit de compte lorsque vous testez quelque chose, et fournit également un moyen de tester les réponses d'erreur localement. localement.