OpenAPI

OpenAPI ist eine Industriestandardspezifikation für die Beschreibung von APIs. Wir verwenden OpenAPI, um um alle unsere APIs zu beschreiben, und wir machen diese Spezifikationen auch öffentlich zugänglich.

Suche nach einer OpenAPI-Spezifikation

Für jedes unserer Produkte gibt es eine eigene OpenAPI-Spezifikation. Der einfachste Weg, sie zu finden, ist die API-Referenz - am oben auf der Seite finden Sie "Download OpenAPI Specification", wo Sie die API-Referenz herunterladen können. Die API-Referenzseiten selbst werden aus diesen Spezifikationen generiert.

An example of the Download OpenAPI Specification section

Jede Spezifikation ist in beiden Varianten erhältlich YAML und JSON Formate; Sie können sie mit einem einfachen Texteditor anzeigen.

Verwenden Sie eine OpenAPI-Spezifikation in Ihren eigenen Projekten

Wenn Sie die OpenAPI-Beschreibung einer API haben, die Sie integrieren möchten, kann das die Sache wirklich erleichtern! Hier sind einige Vorschläge, die Sie vielleicht ausprobieren möchten:

Lokale Dokumentation

Ganz gleich, ob Sie mit einer schlechten Verbindung arbeiten oder die Dinge lieber einfach halten möchten, eine OpenAPI-Spezifikation enthält alle Informationen, die Sie benötigen, um eine lokale Anwendung zur Anzeige der Dokumentation zu starten. ReDoc ist ein Beispiel für ein Open-Source-Dokumentationstool, das Sie verwenden können, um die API-Spezifikation einzusehen.

Postboten-Sammlungen

Wenn Sie bereits ein Postbote Fan, dann könnte Ihnen das gefallen. Wenn nicht, sollten Sie es versuchen.

  1. Laden Sie die Spezifikation für die API, die Sie interessiert, herunter (über die API-Referenzseite)
  2. Klicken Sie in Postman auf "Importieren" und wählen Sie die *.yml Datei, die Sie heruntergeladen haben

.... Das war's. Sie haben nun einen fertigen Satz von Anfragen an die API, fügen Sie nun Ihre Vonage Account-Daten hinzu und los geht's!

Siehe unser Leitfaden für Postboten für weitere Beispiele und fortgeschrittene Verwendung.

Mock-Server für Tests mit Prism

Ein Werkzeug, das viele unserer Entwickler für nützlich halten, ist Prisma. Es ist ein quelloffenes JavaScript-Tool, das eine OpenAPI-Spezifikation akzeptiert und dann das darin beschriebene API-Verhalten imitiert. Es ist ein idealer Weg zur Arbeit mit einer lokalen API zu arbeiten, vermeidet das Aufbrauchen von Account-Guthaben, wenn Sie etwas testen, und bietet auch eine Möglichkeit, Fehlerantworten Antworten lokal zu testen.

Wir haben eine Ausführlicherer Leitfaden für die Arbeit mit Prism und OpenAPI die Sie vielleicht nützlich finden.