Halaman ini berlaku untuk Apigee dan Apigee Hybrid.
Topik ini menjelaskan hal-hal yang perlu Anda ketahui tentang cara membuat dan mengelola versi di hub API.
Apa yang dimaksud dengan versi?
Setiap resource API di hub API memiliki setidaknya satu versi yang terkait dengannya. Anda dapat menganggap versi sebagai status API pada waktu tertentu. Pada dasarnya, versi membantu Anda mengelompokkan dan mengatur API berdasarkan kumpulan operasi dasar, deployment, dan atribut lainnya.
Di hub API, versi merepresentasikan pengelompokan API yang logis. Biasanya, tetapi belum tentu, pengelompokan ini berkisar pada operasi yang dapat dilakukan oleh 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. Ini adalah contoh operasi.
Salah satu praktik yang baik untuk suatu versi adalah menyertakan sekumpulan operasi API yang di-deploy secara bersamaan. Misalnya, API toko hewan peliharaan mungkin memiliki versi yang menyertakan operasi tambah, temukan, dan hapus, yang semuanya di-deploy ke lingkungan yang sama.
Cara baik lainnya untuk memahami versi adalah bahwa versi ini merepresentasikan pandangan produsen API tentang API. API adalah kumpulan fitur dan kemampuan yang dimasukkan oleh orang yang membangun API ke dalamnya dan diharapkan untuk di-deploy dengan API tersebut.
Membuat versi
Misalnya, detail API yang ingin Anda tambahkan ke hub API direkam dalam spesifikasi OpenAPI. Jika demikian, Anda dapat menambahkan spesifikasi ke versi API. Jika Anda melakukannya, hub API akan mengurai spesifikasi dan mengambil informasi dari spesifikasi tersebut, seperti operasi yang disertakan oleh API, dan menyimpan informasi tersebut bersama versi. Jika tidak memiliki spesifikasi OpenAPI, Anda tetap dapat membuat versi, tetapi harus mengisinya secara manual dengan informasi deskriptif yang relevan. Satu kasus lain ketika hub API mendukung penguraian detail API melalui on-ramping 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, operasi ini mungkin menjamin pembuatan versi baru, atau mungkin tidak.
Anggaplah produser API menambahkan operasi baru ke API dan ingin API tersebut di-deploy ke semua deployment yang saat ini terkait dengan versi. Dalam hal ini, produser dapat memilih untuk tidak membuat versi API yang baru. Di sisi lain, jika produsen membuat perubahan yang tidak kompatibel dengan versi sebelumnya (perubahan yang dapat menyebabkan gangguan) dan memilih untuk mengaitkannya dengan deployment baru, sebaiknya Anda membuat versi baru.
Anda dapat melihat bahwa hub API memberikan fleksibilitas bagi Anda untuk menentukan dan mengatur versi API agar sesuai dengan kebutuhan 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.
| Atribut | Deskripsi |
|---|---|
| Tahap siklus proses API | Siklus proses mengacu pada serangkaian tahapan berurutan yang harus dilalui API, mulai dari konsepsi hingga akhir siklus proses. Karena setiap versi API biasanya bergerak melalui siklus prosesnya sendiri secara terpisah, kami tidak secara langsung menetapkan tahap siklus proses suatu API, tetapi mengizinkan setiap versi API untuk memiliki tahap siklus proses yang ditetapkan. |
| Dokumentasi | Link ke dokumentasi API tempat versi dilampirkan. |
| Kepatuhan | Melalui Setelan, Anda dapat menentukan nilai untuk mewakili detail kepatuhan yang penting bagi tim atau organisasi Anda. |
| Akreditasi | Melalui Setelan, Anda dapat menentukan nilai untuk mewakili detail akreditasi yang menarik bagi tim atau organisasi Anda. |
Atribut yang ditentukan pengguna
Bergantung pada kebutuhan tim atau organisasi, Anda dapat menentukan atribut khusus (nama/pasangan nilai) untuk versi. Lihat Setelan.