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