Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Dokumentasikan API menggunakan konsol API Gateway
Di bagian ini, kami menjelaskan cara membuat dan memelihara bagian dokumentasi API menggunakan konsol API Gateway.
Prasyarat untuk membuat dan mengedit dokumentasi API adalah Anda harus sudah membuat API. Pada bagian ini, kita menggunakan [PetStore](http://petstore-demo-endpoint.execute-api.com/petstore/pets)API sebagai contoh. Untuk membuat API menggunakan konsol API Gateway, ikuti petunjuk di[Tutorial: Buat REST API dengan mengimpor contoh](api-gateway-create-api-from-example.md).
**Topics**
+ [Dokumentasikan `API` entitas](#api-gateway-document-api-add-document-part-for-api-entity-with-console)
+ [Dokumentasikan `RESOURCE` entitas](#api-gateway-document-api-add-document-part-for-resource-entity-with-console)
+ [Dokumentasikan `METHOD` entitas](#api-gateway-document-api-add-document-part-for-method-entity-with-console)
+ [Dokumentasikan `QUERY_PARAMETER` entitas](#api-gateway-document-api-add-document-part-for-request-query-entity-with-console)
+ [Dokumentasikan `PATH_PARAMETER` entitas](#api-gateway-document-api-add-document-part-for-path-parameter-entity-with-console)
+ [Dokumentasikan `REQUEST_HEADER` entitas](#api-gateway-document-api-add-document-part-for-request-header-entity-with-console)
+ [Dokumentasikan `REQUEST_BODY` entitas](#api-gateway-document-api-add-document-part-for-request-body-entity-with-console)
+ [Dokumentasikan `RESPONSE` entitas](#api-gateway-document-api-add-document-part-for-response-with-console)
+ [Dokumentasikan `RESPONSE_HEADER` entitas](#api-gateway-document-api-add-document-part-for-response-header-entity-with-console)
+ [Dokumentasikan `RESPONSE_BODY` entitas](#api-gateway-document-api-add-document-part-for-response-body-entity-with-console)
+ [Dokumentasikan `MODEL` entitas](#api-gateway-document-api-add-document-part-for-model-entity-with-console)
+ [Dokumentasikan `AUTHORIZER` entitas](#api-gateway-document-api-add-document-part-for-authorizer-entity-with-console)
## Dokumentasikan `API` entitas
Untuk menambahkan bagian dokumentasi baru untuk `API` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **API**.
Jika bagian dokumentasi tidak dibuat untuk`API`, Anda mendapatkan editor `properties` peta bagian dokumentasi. Masukkan `properties` peta berikut di editor teks.
```
{
"info": {
"description": "Your first API Gateway API.",
"contact": {
"name": "John Doe",
"email": "john.doe@api.com"
}
}
}
```
**catatan**
Anda tidak perlu menyandikan `properties` peta menjadi string JSON. Konsol API Gateway membuat stringifikasi objek JSON untuk Anda.
1. Pilih **Buat bagian dokumentasi**.
Untuk menambahkan bagian dokumentasi baru untuk `API` entitas di panel **Resources**, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Resources**.
1. Pilih menu **tindakan API**, lalu pilih **Perbarui dokumentasi API**.
![\[Edit dokumentasi untuk entitas API di konsol API Gateway\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/document-api-entity-using-new-console.png)
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Pilih nama API Anda, lalu pada kartu API, pilih **Edit**.
## Dokumentasikan `RESOURCE` entitas
Untuk menambahkan bagian dokumentasi baru untuk `RESOURCE` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Sumber Daya**.
1. Untuk **Path**, masukkan jalan.
1. Masukkan deskripsi di editor teks, misalnya:
```
{
"description": "The PetStore's root resource."
}
```
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk sumber daya yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk menambahkan bagian dokumentasi baru untuk `RESOURCE` entitas di panel **Resources**, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Resources**.
1. Pilih sumber daya, lalu pilih **Perbarui dokumentasi**.
![\[Mengedit dokumentasi untuk entitas sumber daya di konsol API Gateway\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/document-resource-entity-using-new-console.png)
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Pilih sumber daya yang berisi bagian dokumentasi Anda, lalu pilih **Edit**.
## Dokumentasikan `METHOD` entitas
Untuk menambahkan bagian dokumentasi baru untuk `METHOD` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Metode**.
1. Untuk **Path**, masukkan jalan.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Masukkan deskripsi di editor teks, misalnya:
```
{
"tags" : [ "pets" ],
"summary" : "List all pets"
}
```
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk metode yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk menambahkan bagian dokumentasi baru untuk `METHOD` entitas di panel **Resources**, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Resources**.
1. Pilih metode, lalu pilih **Perbarui dokumentasi**.
![\[Edit dokumentasi untuk entitas metode di konsol API Gateway\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/document-method-entity-using-new-console.png)
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih metode atau memilih sumber daya yang berisi metode, dan kemudian menggunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `QUERY_PARAMETER` entitas
Untuk menambahkan bagian dokumentasi baru untuk `QUERY_PARAMETER` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Parameter kueri**.
1. Untuk **Path**, masukkan jalan.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Untuk **Nama**, masukkan nama.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk parameter kueri yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih parameter kueri atau memilih sumber daya yang berisi parameter kueri, dan kemudian menggunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `PATH_PARAMETER` entitas
Untuk menambahkan bagian dokumentasi baru untuk `PATH_PARAMETER` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **parameter Path**.
1. Untuk **Path**, masukkan jalan.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Untuk **Nama**, masukkan nama.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk parameter jalur yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih parameter jalur atau memilih sumber daya yang berisi parameter jalur, lalu menggunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `REQUEST_HEADER` entitas
Untuk menambahkan bagian dokumentasi baru untuk `REQUEST_HEADER` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Request header**.
1. Untuk **Path**, masukkan jalur untuk header permintaan.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Untuk **Nama**, masukkan nama.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk header permintaan yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih header permintaan atau memilih sumber daya yang berisi header permintaan, dan kemudian menggunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `REQUEST_BODY` entitas
Untuk menambahkan bagian dokumentasi baru untuk `REQUEST_BODY` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Request body**.
1. Untuk **Path**, masukkan jalur untuk badan permintaan.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk badan permintaan yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih badan permintaan atau memilih sumber daya yang berisi badan permintaan, lalu menggunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `RESPONSE` entitas
Untuk menambahkan bagian dokumentasi baru untuk `RESPONSE` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Respons (kode status)**.
1. Untuk **Path**, masukkan jalur untuk respons.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Untuk **kode Status**, masukkan kode status HTTP.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk kode status respons yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih kode status respons atau memilih sumber daya yang berisi kode status respons, lalu gunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `RESPONSE_HEADER` entitas
Untuk menambahkan bagian dokumentasi baru untuk `RESPONSE_HEADER` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **header Response**.
1. Untuk **Path**, masukkan jalur untuk header respons.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Untuk **kode Status**, masukkan kode status HTTP.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk header respons yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih header respons atau memilih sumber daya yang berisi header respons, lalu gunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `RESPONSE_BODY` entitas
Untuk menambahkan bagian dokumentasi baru untuk `RESPONSE_BODY` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Badan respons**.
1. Untuk **Path**, masukkan jalur untuk badan respons.
1. Untuk **Metode**, pilih kata kerja HTTP.
1. Untuk **kode Status**, masukkan kode status HTTP.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk badan respons yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Sumber dan metode**.
1. Anda dapat memilih badan respons atau memilih sumber daya yang berisi badan respons, lalu menggunakan bilah pencarian untuk menemukan dan memilih bagian dokumentasi Anda.
1. Pilih **Edit**.
## Dokumentasikan `MODEL` entitas
Mendokumentasikan `MODEL` entitas melibatkan pembuatan dan pengelolaan `DocumentPart` instance untuk model dan masing-masing model '. `properties` Misalnya, untuk `Error` model yang disertakan dengan setiap API secara default memiliki definisi skema berikut,
```
{
"$schema" : "http://json-schema.org/draft-04/schema#",
"title" : "Error Schema",
"type" : "object",
"properties" : {
"message" : { "type" : "string" }
}
}
```
dan membutuhkan dua `DocumentationPart` contoh, satu untuk `Model` dan yang lainnya untuk `message` propertinya:
```
{
"location": {
"type": "MODEL",
"name": "Error"
},
"properties": {
"title": "Error Schema",
"description": "A description of the Error model"
}
}
```
and
```
{
"location": {
"type": "MODEL",
"name": "Error.message"
},
"properties": {
"description": "An error message."
}
}
```
Saat API diekspor, properti akan mengganti nilai dalam skema asli. `DocumentationPart`
Untuk menambahkan bagian dokumentasi baru untuk `MODEL` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Model**.
1. Untuk **Nama**, masukkan nama untuk model.
1. Masukkan deskripsi di editor teks.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk model yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi ke model lain.
Untuk menambahkan bagian dokumentasi baru untuk `MODEL` entitas di panel **Model**, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Model**.
1. Pilih model, lalu pilih **Perbarui dokumentasi**.
![\[Edit dokumentasi untuk entitas model di konsol API Gateway\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/document-model-entity-using-new-console.png)
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Model**.
1. Gunakan bilah pencarian atau pilih model, lalu pilih **Edit**.
## Dokumentasikan `AUTHORIZER` entitas
Untuk menambahkan bagian dokumentasi baru untuk `AUTHORIZER` entitas, lakukan hal berikut:
1. Di panel navigasi utama, pilih **Dokumentasi**, lalu pilih **Buat bagian dokumentasi**.
1. Untuk **jenis Dokumentasi**, pilih **Authorizer**.
1. Untuk **Nama**, masukkan nama otorisasi Anda.
1. Masukkan deskripsi di editor teks. Tentukan nilai untuk `location` bidang yang valid untuk otorisasi.
1. Pilih **Buat bagian dokumentasi**. Anda dapat membuat dokumentasi untuk otorisasi yang tidak terdaftar.
1. Jika diperlukan, ulangi langkah-langkah ini untuk menambah atau mengedit bagian dokumentasi ke otorisasi lain.
Untuk mengedit bagian dokumentasi yang ada, lakukan hal berikut:
1. Di panel **Dokumentasi**, pilih tab **Authorizers**.
1. Gunakan bilah pencarian atau pilih otorisasi, lalu pilih **Edit**.