第1章 OpenAPI サービスの設定
OpenAPI 仕様 (OAS) は、HTTP API 向けに、プログラミング言語に依存しない、標準のインターフェイスを定義します。ソースコード、追加のドキュメント、またはネットワークトラフィックの検査にアクセスしなくても、サービスの機能を理解することができます。OpenAPI を使用してサービスを定義すると、最小限の実装ロジックを使用してサービスを理解し、操作することができます。インターフェイスの記述によって低レベルのプログラミングが簡素化されるのと同様に、OpenAPI 仕様 によってサービス呼び出し時の推測作業がなくなります。
1.1. OpenAPI 関数定義 リンクのコピーリンクがクリップボードにコピーされました!
サーバーレスロジックでは、ワークフローが関数内で OpenAPI 仕様参照を使用してリモートサービスとやり取りすることが可能です。
OpenAPI 関数定義の例
{
"functions": [
{
"name": "myFunction1",
"operation": "specs/myopenapi-file.yaml#myFunction1"
}
]
}
operation 属性は、次のパラメーターで構成される string です。
-
URI: エンジンはこれを使用して仕様ファイルを見つけます。 - Operation identifier: この識別子は OpenAPI 仕様ファイルにあります。
サーバーレスロジックは、以下の URI スキームをサポートしています。
- file: ファイルシステム内にあるファイルに使用します。
-
httpまたはhttps: これらはリモートにあるファイルに使用します。
ビルド時に OpenAPI 仕様ファイルが利用可能であることを確認してください。サーバーレスロジックは、実行時にリクエストを送信するために内部コード生成機能を使用します。アプリケーションイメージをビルドした後、サーバーレスロジックはこれらのファイルにアクセスできなくなります。
ワークフローに追加する OpenAPI サービスに仕様ファイルがない場合は、仕様ファイルを作成するか、サービスを更新してファイルを生成して公開できます。