Halaman ini berlaku untuk Apigee dan Apigee hybrid.
Topik ini menjelaskan hal-hal yang perlu Anda ketahui tentang cara membuat dan mengelola versi di API Hub.
Apa yang dimaksud dengan versi?
Setiap resource API di API Hub memiliki setidaknya satu versi yang terkait dengannya. Anda dapat menganggap versi sebagai status API pada suatu waktu. Pada dasarnya, versi membantu Anda mengelompokkan dan mengatur API berdasarkan kumpulan operasi, deployment, spesifikasi, dan atribut lainnya yang mendasarinya, seperti yang ditunjukkan dalam Gambar 1.
Gambar 1. Setiap versi dapat memiliki operasi, deployment, dan atribut lainnya.
Di API Hub, versi mewakili pengelompokan API yang logis. Biasanya, tetapi tidak selalu, pengelompokan ini berkisar pada operasi yang dapat dilakukan API. Misalnya, Anda memiliki Pet Store API, dan versi pertama API ini memungkinkan Anda melakukan tugas dasar, seperti menambahkan hewan peliharaan, menemukan hewan peliharaan, dan menghapus hewan peliharaan dari toko. Berikut adalah contoh operasi.
Sebaiknya versi menyertakan serangkaian operasi API yang di-deploy secara bersamaan. Misalnya, API toko hewan peliharaan mungkin memiliki versi yang menyertakan operasi tambahkan, temukan, dan hapus, yang semuanya di-deploy ke lingkungan yang sama.
Cara lain yang baik untuk memahami versi adalah bahwa versi mewakili tampilan API dari produsen API. Ini adalah kumpulan fitur dan kemampuan yang dimasukkan oleh orang yang mem-build API dan diharapkan akan di-deploy dengan API tersebut.
Membuat versi
Misalnya, detail API yang ingin Anda tambahkan ke API Hub diambil dalam spesifikasi OpenAPI. Jika demikian, Anda dapat menambahkan spesifikasi ke versi API. Jika Anda melakukannya, API Hub akan mengurai spec dan mengambil informasi darinya, seperti operasi yang disertakan API, dan menyimpan informasi tersebut dengan versi. Jika tidak memiliki spesifikasi OpenAPI, Anda masih dapat membuat versi, tetapi Anda harus mengisinya secara manual dengan informasi deskriptif yang relevan. Satu kasus lain saat API hub mendukung penguraian detail API melalui pendaftaran otomatis proxy API Apigee.
Anda dapat mengupload beberapa file spesifikasi API ke versi yang sama.
Kapan harus membuat versi baru?
Jika operasi baru ditambahkan ke API, hal ini mungkin memerlukan pembuatan versi baru, atau mungkin tidak.
Misalnya, produsen API menambahkan operasi baru ke API dan ingin men-deploy-nya ke semua deployment yang saat ini terkait dengan versi tersebut. Dalam hal ini, produsen dapat memilih untuk tidak membuat versi API baru. Di sisi lain, jika produsen membuat perubahan yang tidak kompatibel dengan versi lama (perubahan yang dapat menyebabkan gangguan) dan memilih untuk mengaitkannya dengan deployment baru, sebaiknya buat versi baru.
Anda dapat melihat bahwa API hub memberikan fleksibilitas bagi Anda untuk menentukan dan mengatur versi API agar paling sesuai dengan kebutuhan organisasi dan kebutuhan produsen API tertentu.
Atribut sistem
Versi menyertakan atribut sistem berikut secara default. Anda dapat mengubah nilai yang terkait dengan atribut ini di Setelan. Untuk mengetahui detailnya, lihat Mengelola atribut.
| Atribut | Deskripsi |
|---|---|
| Siklus proses | Siklus proses mengacu pada serangkaian tahap yang terurut yang harus dilalui API, mulai dari konsep hingga akhir siklus proses. Karena setiap versi API biasanya bergerak melalui siklus prosesnya sendiri secara terpisah, kami tidak langsung menetapkan tahap siklus proses API, tetapi mengizinkan setiap versi API memiliki tahap siklus proses yang ditetapkan. |
| Kepatuhan | Melalui Setelan, Anda dapat menentukan nilai untuk mewakili detail kepatuhan yang menarik bagi tim atau organisasi Anda. Untuk mengetahui detailnya, lihat Mengelola atribut. |
| Akreditasi | Melalui Setelan, Anda dapat menentukan nilai untuk mewakili detail akreditasi yang menarik bagi tim atau organisasi Anda. Untuk mengetahui detailnya, lihat Mengelola atribut. |
| Dokumentasi | Link ke dokumentasi untuk API yang dilampirkan versinya. |
Atribut yang ditentukan pengguna
Bergantung pada kebutuhan tim atau organisasi, Anda dapat menentukan atribut kustom (pasangan nama/nilai) untuk versi. Lihat Mengelola atribut.