Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Tentang spesifikasi API
Spesifikasi API menggunakan format standar untuk mendeskripsikan API. Data ini dapat dibaca oleh mesin, tetapi juga mudah dibaca dan dipahami oleh manusia. Spesifikasi biasanya menjelaskan elemen API seperti jalur dasarnya, jalur dan kata kerja, header, parameter kueri, operasi, jenis konten, deskripsi respons, dan sebagainya.
Versi API dapat berisi beberapa spesifikasi API dari jenis yang sama atau berbeda seperti Spesifikasi OpenAPI, Proto, dan WSDL. Jika didukung, hub API dapat mengurai spesifikasi API untuk mengekstrak dan menyimpan metadata API, seperti ID API, ID versi, deskripsi, dan operasi. Lihat Penguraian spesifikasi.
Menggunakan spesifikasi API dengan hub API
Anda dapat membuat versi API di hub API dengan atau tanpa spesifikasi API.
Anda dapat mengupload spesifikasi pada saat membuat versi. Ketika menampilkan detail API di antarmuka pengguna, Anda akan melihat daftar spesifikasi apa pun yang terkait dengan versi resource API.
Anda juga dapat membuat dan mengonfigurasi versi dengan spesifikasi menggunakan REST API. Saat menggunakan API, Anda membuat entity versi API dengan spesifikasi, lalu Anda dapat melampirkan versi tersebut ke resource API.
Untuk informasi selengkapnya, lihat Menambahkan spesifikasi ke versi.
Penguraian spesifikasi
Jika didukung, hub API dapat mengurai spesifikasi API untuk mengekstrak informasi tentang API dan menyimpannya dengan versi API. Misalnya, hub API dapat mengurai spesifikasi OpenAPI API untuk mengekstrak dan menyimpan ID API, ID versi, deskripsi, operasi, dan metadata lainnya.
Hub API juga mendukung validasi spesifikasi. Lihat Memvalidasi spesifikasi API.