投稿日: Dec 1, 2016
API 利用者が API を理解しやすくなるよう、Amazon API Gateway を使用して構築した API のメソッドやリソースにドキュメントを追加できるようになりました。API Gateway コンソール、CLI, You can add documentation for your API directly using the API Gateway console、CLI、および SDK を使用して直接 API 向けのドキュメントを追加することも、シンプルに API の Swagger 定義内でドキュメントタグを使用して指定することもできます。また、API の共通の側面については、ドキュメントを再使用することもできます。たとえば、標準エラーのドキュメントを 1 回だけ作成し、実際のコンテンツは重複させることなく複数の API 応答でそれを使用することができます。これにより、API のドキュメント化を速くし、文字列の重複を行う際に発生する「コピーとペースト」のエラーをなくすことができます。いったんドキュメントを API ステージの一部として公開すれば、Swagger のエクスポート機能を使用してエクスポートし、自分の開発者ポータルでそれを利用可能にできます。
Amazon API Gateway は、API の定義と API のドキュメント化のために独立したワークフローを提供します。これにより、API 開発者とテクニカルライターは並行して作業し、コンソール、CLI、および SDK を使用して Swagger を個別にインポートすることができます。
詳細については、API Gateway API のドキュメント化を参照してください。