OpenAPI -Definitionsdatei erstellen

Online bearbeiten

APIs werden in OpenAPI -Definitionsdateien im YAML-Format definiert. Sie können eine standardmäßige OpenAPI -Definitionsdatei mit dem Befehl create erstellen und sie anschließend mit einem Editor Ihrer Wahl ändern.

Sie können die API direkt in einem Katalog im API Manager bereitstellen oder veröffentlichen, indem Sie die API in einer Produktdefinitionsdatei referenzieren und anschließend den apic products:publish Befehl zum Veröffentlichen des Produkts verwenden. Sie können auch einen API-Entwurf in API Manager erstellen, indem Sie den Befehl apic draft-apis:create verwenden.

Sie können eine API in der CLI erstellen, indem Sie den Befehl ausführen apic create:apiund zusätzliche Argumente in der Befehlszeile angeben.

Eine weitere Option besteht darin, eine API interaktiv in der Befehlszeile zu erstellen, indem Sie apic create:api ausführen und die Eingabeaufforderungen befolgen.

Sie können weitere Details und verfügbare Optionen für den Befehl apic create:api anzeigen, indem Sie den folgenden Befehl ausführen:

apic create:api --help

IBM bietet eine Erweiterung der Spezifikation „ OpenAPI “; diese Erweiterung wird unter IBM als Erweiterung der Spezifikation „ OpenAPI “ beschrieben.

Hinweis: Produkte, die eine API mit einer Swagger-Eigenschaft mit regex enthalten, die Lookahead-Zusicherungen wie "(?" enthalten, können nicht validiert oder veröffentlicht werden. Es wird eine Fehlernachricht zurückgegeben. Beispiel:

Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400

API-Definition aus einer Vorlage erstellen

Sie können eine angepasste Handlebars-Vorlage zum Erstellen einer API verwenden, indem Sie den folgenden Befehl ausführen:

apic create:api --template template_filename --title api_title

Dabei ist Name_der_Vorlagendatei der Name der zu verwendenden Handlebars-Vorlage und API-Titel ist der Titel Ihrer API.

Eine API-Vorlagendatei muss die Dateinamenerweiterung .hbs aufweisen. Sie können eine Vorlage von Grund auf neu erstellen oder mit der Beispielvorlage (Standardvorlage) beginnen, die unter „Beispiele für API- und Produktdefinitionsvorlagen“ bereitgestellt wird.

Sie können mehrsprachige API-und Produktdokumentation erstellen, indem Sie eine x-ibm-languages -Erweiterung direkt in der OpenAPI -Definition verwenden. Weitere Informationen finden Sie unter „Erstellen mehrsprachiger API- und Produktdokumentationen mit x-ibm-languages “.