Grundlagen der OpenAPI-Spezifikation
Geschrieben vonAleksi Hytönen Vor über einer Woche aktualisiertTable of contentsEinführung in die OpenAPI-Spezifikation
Beim Erstellen einer API besteht die erste Aufgabe darin, diese zu definieren. Dies geschieht mithilfe der standardmäßigen OpenAPI-Spezifikation, die früher als Swagger-Spezifikation bekannt war. Derzeit unterstützt Frends OpenAPI 2.0 und OpenAPI 3.0 sowohl im JSON- als auch im YAML-Format.
Die OpenAPI-Definition kann manuell oder mithilfe eines grafischen OpenAPI-Designtools erstellt werden, wie beispielsweiseAmpel, um die API-Spezifikation zu entwerfen und die Definition dann in Frends zu importieren.
In diesem Kurs werden wir nicht auf alle Details der OpenAPI-Spezifikation eingehen und auch keine OpenAPI-Designtools verwenden. Stattdessen werden wir die wichtigsten Teile anhand von Beispielen behandeln. Die vollständige OpenAPI 3.0-Spezifikation ist kostenlos verfügbar unterStolzieren.
Der nächste Artikel istOpenAPI 2.0 oder OpenAPI 3.0
Verwandte ArtikelAPI-VerwaltungSchreiben einer API-Spezifikation in Frends: Teil 1Einführung in das Erstellen Ihrer ersten API und API-DefinitionEinführung in OpenAPI 2.0 und OpenAPI 3.0Einführung in die API-Spezifikation So verwenden Sie den Swagger Editor