API とアプリケーションの作成

デベロッパーズ・ツールキットを使用して、API プロキシーと API 実装を開発できます。この資料では、API は API プロキシーを指し、アプリケーション は API 実装を指します。

開発者ツールキットを使用すると、OpenAPIを使用して既存のバックエンド実装へのプロキシを作成したり、Express、Java™、Swift、Goなどの他の言語やフレームワークで開発されたアプリケーションを拡張したりすることで、言語に依存しないAPIを作成できます。

開発成果物定義の作成

開発成果物を作成するには、apic create コマンドを以下のように使用します。

コマンド	説明
`apic create:api`	OpenAPI 定義を作成します。
`apic create:api --wsdl filename`	WSDL 定義ファイル、またはサービスの WSDL 定義ファイルを含む .zip ファイルから SOAP API 定義を作成します。生成された API の名前およびバージョンは、WSDL ファイルから取得されます。 .zip ファイルをアップロードする場合は、.zip ファイルにオプション・ファイルを組み込んで追加のディレクティブを指定できます。詳しくは、「 WSDL サービスのインポート時のオプション・ファイルの使用」を参照してください。
`apic create:product`	API 製品定義を作成する。

注: --template template-name オプションを使用して、 OpenAPI テンプレート・ファイルから API または製品を作成できます。

--title オプションを指定することで、製品定義と API 定義を非対話式で作成することもできます。このオプションは、追加のオプションでカスタマイズすることもできる複数の値を設定します。以下に例を示します。

apic create:api --title Routes
apic create:product --title "Climb On"

API 定義と製品定義を同時に作成することもできます。

apic create:api --title Routes --product "Climb On"
apic create:api --wsdl globalweather.wsdl --product "Weather Forecasting"

あるいは、API を作成し、新規製品の作成時にそれらを参照することもできます。以下に例を示します。

apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"

開発成果物定義の検証

開発成果物の編集後、または公開前に、それらを検証することがベスト・プラクティスです。以下に例を示します。

apic validate routes.yaml                      # Validate an API
apic validate climb-on.yaml                    # Validate the Product and its APIs
apic validate climb-on.yaml --product-only     # Validate the Product only (do not validate the referenced APIs)

注: API を定義する OpenAPI ファイルが、別のファイルで定義されている OpenAPI コードのフラグメントを参照するために $ref フィールドを使用する場合、ドラフト API が apic drafts:validate コマンドで作成される前に、 $ref フィールドがターゲット・ファイルの内容に置き換えられます。詳しくは、 $ref を使用した OpenAPI ファイル内のコード・フラグメントの再利用を参照してください。