OpenAPI (Swagger 2.0) 定義ファイルの作成

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

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

apic create --type api を実行して CLI で API を作成し、他の引数をコマンド・ラインで追加することができます。

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

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

apic create --type api --help

IBM は OpenAPI (Swagger 2.0) 仕様に対する拡張を提供しています。この拡張については、OpenAPI (Swagger 2.0) 仕様に対する IBM 拡張で説明しています。

テンプレートからの API 定義の作成

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

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

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

--template オプションを指定する代わりに、以下の構成変数を設定できます。

template-default-api - .hbs テンプレート・ファイルの基本ファイル名を表します。
template-path - テンプレート・ファイルが格納されているディレクトリーを表します。

詳しくは、API 定義テンプレートおよび製品定義テンプレートの作成と使用を参照してください。

API テンプレート・ファイルには、.hbs というファイル名拡張子が必要です。テンプレートは、まったく新規に作成することも、API 定義と製品定義のテンプレートの例で提供されているサンプル (デフォルト) の API テンプレートを基に作成することもできます。

IBM API Connect バージョン 5.0.7.2 より、x-ibm-languages 拡張を OpenAPI (Swagger 2.0) 定義で直接使用することにより、複数言語の API および製品のドキュメンテーションを作成できるようになりました。詳しくは、x-ibm-languages を使用した API および製品のマルチリンガル・ドキュメンテーションの作成を参照してください。

最終更新: 2017 年 10 月 31 日