Dokumentasi untuk REST APIs di API Gateway

Untuk membantu pelanggan memahami dan menggunakan API Anda, Anda harus mendokumentasikan API. Untuk membantu Anda mendokumentasikan API, API Gateway memungkinkan Anda menambahkan dan memperbarui konten bantuan untuk entitas API individual sebagai bagian integral dari proses pengembangan API Anda. API Gateway menyimpan konten sumber dan memungkinkan Anda mengarsipkan versi dokumentasi yang berbeda. Anda dapat mengaitkan versi dokumentasi dengan tahap API, mengekspor snapshot dokumentasi khusus tahap ke file OpenAPI eksternal, dan mendistribusikan file sebagai publikasi dokumentasi.

Untuk mendokumentasikan API Anda, Anda dapat memanggil API Gateway REST API, menggunakan salah satunya AWS SDKs, menggunakan AWS CLIfor API Gateway, atau menggunakan konsol API Gateway. Selain itu, Anda dapat mengimpor atau mengekspor bagian dokumentasi yang didefinisikan dalam file OpenAPI eksternal.

Untuk berbagi dokumentasi API dengan pengembang, Anda dapat menggunakan portal pengembang. Sebagai contoh, lihat Mengintegrasikan ReadMe dengan API Gateway untuk Menjaga Hub Pengembang Anda Tetap Terbaru atau Cara Merampingkan Pengembangan API di Amazon API Gateway Menggunakan blog SmartBear Jaringan AWS Partner (APN). SwaggerHub