OpenAPI 定義ファイルの作成

API は、YAML 形式の OpenAPI 定義ファイルで定義されます。デフォルトの OpenAPI 定義ファイルは、 create コマンドを使用して作成し、任意のエディターを使用して変更することができます。

製品定義ファイルで API を参照し、 apic products:publish コマンドを使用して製品を公開することにより、 API Manager でカタログに API を直接ステージングまたは公開できます。 apic draft-apis:create コマンドを使用して、 API Manager でドラフト API を作成することもできます。

CLI で API を作成するには、apic create:api を実行し、コマンド・ラインで追加の引数を指定します。

コマンド・ラインで対話式に API を作成するもう 1 つの方法は、apic create:api を実行し、プロンプトに従う方法です。

以下を実行すると、apic create:api コマンドの詳細および使用可能なオプションを表示することができます。

apic create:api --help

IBM は、 OpenAPI 仕様に対する拡張機能を提供します。この拡張機能については、 OpenAPI 仕様に対するIBM 拡張機能で説明されています。

注: 先読みアサーション (「(?」など) を含む 正規表現 を使用する Swagger プロパティーを持つ API を含む製品は、検証も公開もできません。エラー・メッセージが返されます。以下に例を示します。

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 定義の作成

以下のコマンドを使用することにより、カスタム Handlebars テンプレートを使用して API を作成できます。

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

ここで、template_filename は使用する Handlebars テンプレートの名前であり、api_title は API のタイトルです。

API テンプレート・ファイルには、.hbs というファイル名拡張子が必要です。テンプレートは、最初から作成することも、 API および製品定義テンプレートの例で提供されているサンプル (デフォルト) API テンプレートから作成することもできます。

OpenAPI 定義で x-ibm-languages 拡張を直接使用して、多言語の API および製品資料を作成できます。詳しくは、 Using x-ibm-languages to create multilingual API and Product documentationを参照してください。