Einführung in den Header-Abschnitt der API-Definition

Frends Frends Integration Development
1

API-Entwicklung

Ossi Galkin avatarGeschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contents

Header-Abschnitt der API-Definition

Beginnen wir mit dem Header-Teil der OpenAPI-Definition. Hier ist der OpenAPI-Header aus unserer Beispiel-Time-API und darunter eine Beschreibung der Header-Felder:
​
​

openapi: 3.0.1 Info: Titel: Zeit-API Beschreibung: Einfache API zur Bereitstellung der aktuellen Zeit Version: 1.0.0 Server: - URL: /api/time/v1

OpenAPI-Objekt

Beschreibung

openapi: 3.0.1

OpenAPI-Version. Derzeit unterstützt Frends OpenAPI v3.0.1 und ältere Versionen.

Info: Titel: Zeit-API. Beschreibung: Einfache API zur Bereitstellung der aktuellen Zeit. Version: 1.0.0

Titel: Der Titel der API, der als Name der API auf der Registerkarte „Frends-API“ angezeigt wird.
​
​Beschreibung: Dies ist eine rein dokumentarische Eigenschaft, die erklärt, warum die API existiert.
​
​Version: Hier wird die Version der API angegeben. Wenn Änderungen vorgenommen werden, die nicht abwärtskompatibel sind, muss eine neue Version der API erstellt werden.

Eine ausführlichere Dokumentation zum Info-Objekt finden Sie hierLink.

Server: - URL: /API/Zeit/v1

Hier definieren Sie den relativen Pfad zur API. Der absolute Pfad wird angezeigt, nachdem die OpenAPI-Definition gespeichert oder in einem Agenten veröffentlicht wurde.

Der nächste Artikel istEinführung in den Abschnitt „API-Pfade“

Verwandte ArtikelBest Practices zur Versionierung von APIsEinführung in das Erstellen Ihrer ersten API und API-DefinitionBeispiel zum Erstellen Ihrer ersten API-DefinitionEinführung in den Abschnitt „API-Pfade“Einführung in die Definition der Verwendung von API-Schlüsseln in der OpenAPI-Spezifikation