REST API をドキュメント化する - Amazon API Gateway

REST API をドキュメント化する

顧客が API について理解して使いやすくするため、API をドキュメント化してください。API をドキュメント化しやすいように、API Gateway では API 開発プロセスの不可欠な部分として個々の API エンティティのヘルプコンテンツを追加および更新できます。API Gateway にはソースコンテンツが保存され、さまざまなバージョンのドキュメントをアーカイブできます。ドキュメントバージョンと API ステージを関連付けたり、ステージ固有のドキュメントスナップショットを外部 OpenAPI ファイルにエクスポートしたり、ファイルをドキュメントの出版物として配布したりすることができます。

API をドキュメント化するには、API Gateway REST API を呼び出し、API Gateway に AWS SDK または AWS CLI のいずれかを使用するか、API Gateway コンソールを使用します。加えて、外部 OpenAPI ファイルで定義されたドキュメントパーツをインポートまたはエクスポートすることができます。API をドキュメント化する方法を説明する前に、API ドキュメントが API Gateway でどのように表現されるかを示します。