API Gateway での REST API のドキュメント - Amazon API Gateway

API Gateway での REST API のドキュメント

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

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

API ドキュメントをデベロッパーと共有するには、デベロッパーポータルを使用できます。例については、AWS パートナーネットワーク (APN) ブログの「Developer Hub を最新の状態に保つための ReadMe と API Gateway の統合」または「SmartBear の SwaggerHub を使用して Amazon API Gateway での API 開発を効率化する方法」を参照してください。

トピック