REST API をドキュメント化する
顧客が API について理解して使いやすくするため、API をドキュメント化してください。API をドキュメント化しやすいように、API Gateway では API 開発プロセスの不可欠な部分として個々の API エンティティのヘルプコンテンツを追加および更新できます。API Gateway にはソースコンテンツが保存され、さまざまなバージョンのドキュメントをアーカイブできます。ドキュメントバージョンと API ステージを関連付けたり、ステージ固有のドキュメントスナップショットを外部 OpenAPI ファイルにエクスポートしたり、ファイルをドキュメントの出版物として配布したりすることができます。
API をドキュメント化するには、API Gateway REST API を呼び出して、API Gateway 用の AWS SDK
API ドキュメントをデベロッパーと共有するには、デベロッパーポータルを使用できます。例については、AWS パートナーネットワーク (APN) ブログの「Integrating ReadMe with API Gateway to Keep Your Developer Hub Up to Date