OpenAPI -Definitionsbeispiel

1. Was sind OpenAPI -Definitionen?
2. Was ist ein OpenAPI -Spezifikationsbeispiel?
3. So schreiben Sie OpenAPI -Spezifikation?

Was sind OpenAPI -Definitionen?

Die OpenAPI -Spezifikation ist ein Standardformat zum Definieren von Struktur und Syntax -REST -APIs. OpenAPI-Dokumente sind sowohl maschinell als auch menschenlesbar, sodass jeder leicht feststellen kann, wie jede API funktioniert. Ingenieure, die APIs bauen.

Was ist ein OpenAPI -Spezifikationsbeispiel?

Ein OpenAPI -Dokument, das der OpenAPI -Spezifikation entspricht. Wenn beispielsweise ein Feld einen Array -Wert hat, wird die JSON -Array -Darstellung verwendet: "Feld": [1, 2, 3]

So schreiben Sie OpenAPI -Spezifikation?

Das Erstellen einer Spezifikation erfordert ein einfaches Setup. Sie müssen einen Titel, eine Beschreibung und eine Versionsnummer für Ihre API definieren. Sie müssen auch angeben, welche Swagger -Version Sie im Feld Typ verwenden: Dies ist Ihr Ausgangspunkt (ansonsten an Ihr Projekt angepasst), wenn Sie Ihre API -Definitionen erstellen.