Dokumentasi untuk REST APIs di API Gateway

Untuk membantu pelanggan memahami dan menggunakan AndaAPI, Anda harus mendokumentasikanAPI. Untuk membantu Anda mendokumentasikanAPI, API Gateway memungkinkan Anda menambahkan dan memperbarui konten bantuan untuk masing-masing API entitas sebagai bagian integral dari proses API pengembangan Anda. APIGateway menyimpan konten sumber dan memungkinkan Anda mengarsipkan berbagai versi dokumentasi. Anda dapat mengaitkan versi dokumentasi dengan API tahapan, mengekspor snapshot dokumentasi khusus tahap ke API file Open eksternal, dan mendistribusikan file sebagai publikasi dokumentasi.

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

Untuk berbagi API dokumentasi 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 API Pengembangan SwaggerHub di Amazon API Gateway Menggunakan SmartBear blog Jaringan AWS Mitra (APN).