Auswählen von OpenAPI-Versionen
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsOpenAPI 2.0 oder OpenAPI 3.0?
Ursprünglich begann die Frends API-Entwicklung mit der Unterstützung von OpenAPI 2.0 (auch als Swagger bekannt), wobei die volle Unterstützung für die OpenAPI 3.0-Spezifikation in Version 5.3 veröffentlicht wurde. Die Wahl zwischen Swagger/OpenAPI 2.0 und der OpenAPI 3.0-Spezifikation hängt nur von einer Sache ab:
Wenn Sie mit einer Frends-Version vor 5.3 arbeiten, ist OpenAPI 2.0 die einzige Option.
Ab 5.3 wird empfohlen, die neueste Version der Spezifikation zu verwenden.
Beachten Sie, dass es empfohlen wird, die OpenAPI 2.0-Spezifikation auf Version 3.0 zu konvertieren, wenn Ihre aktuelle Frends-Umgebung der 5.2.x-Serie entspricht und Sie ein Update auf Version 5.3 oder höher planen. Mit der Versionsänderung wurde die Validierung der OpenAPI-Spezifikation strenger, und infolgedessen funktionieren Funktionen oder API-Schlüsselsicherheitsschemata möglicherweise nicht mehr wie zuvor (sieheVersionshinweise).
Das Referenzhandbuch zu OpenAPI 2.0 finden Sie hierLink.
Das Referenzhandbuch zu OpenAPI 3.0 finden Sie hierLink.
Der nächste Artikel istEinführung in den Header-Abschnitt der API-Definition
Verwandte ArtikelAPI-Verwaltung5.3 VersionshinweiseSchreiben einer API-Spezifikation in Frends: Teil 1Einführung in die OpenAPI-SpezifikationEinführung in die API-Spezifikation So verwenden Sie den Swagger Editor