Gambaran Umum

Seiring API berkembang untuk memenuhi tuntutan pasar dan memanfaatkan kemajuan teknologi, manajemen versi menjadi penting. Open API berfungsi sebagai kanal penting bagi tim teknis untuk menghadirkan layanan dan data ke pihak eksternal. Namun, evolusi bisnis dan kemajuan teknologi tidak terhindarkan akan menghasilkan beberapa iterasi versi endpoint Anda. Perubahan ini bersifat alami dan diperlukan saat tim mengoptimalkan fungsionalitas, memperkenalkan fitur baru, dan menangani bug.

Mengelola beberapa versi API sangat penting untuk melayani berbagai kelompok pengguna sekaligus memastikan kompatibilitas dan inovasi. Pendekatan ini memungkinkan tim menghadirkan layanan yang stabil dan terus berkembang sambil mempertahankan kontrol versi, meminimalkan gangguan bagi pengguna yang sudah ada, serta memastikan kesinambungan dan keandalan bisnis.

Kasus Penggunaan

Tim mungkin perlu menawarkan beberapa versi API secara bersamaan—seperti versi terbaru, stabil, dan pemeliharaan jangka panjang—untuk memastikan gangguan minimal bagi pengguna pada versi lama.

Sorotan Fitur Versi API

Pembuatan Versi Lengkap

Versi API baru dapat dibuat berdasarkan versi API yang sudah ada, berisi salinan semua endpoint dari versi asli. Setelah dibuat, setiap endpoint di dalam versi tersebut dapat dimodifikasi sesuai kebutuhan. Sebagai alternatif, Anda dapat memulai dari versi API kosong dan menambahkan endpoint secara manual.

Berbagi Secara Komprehensif

Pilih satu atau beberapa versi API dari proyek Anda untuk dipublikasikan. Semua endpoint dalam versi yang dipilih akan terlihat oleh pengguna. Saat memublikasikan, nama tampilan versi API dan pengaturan slug dapat dikonfigurasi untuk meningkatkan pengalaman pembaca.

Beralih dengan Satu Klik

Jika beberapa versi API telah dipublikasikan, pengguna dapat beralih di antara versi tersebut melalui pemilih versi yang terletak di sebelah nama proyek pada halaman publik. Mengeklik sebuah versi akan menampilkan semua endpoint dan konten terkait untuk versi spesifik tersebut.

Perbedaan Antara "Versi API" dan "Cabang Sprint"

Versi API: Dirancang untuk rilis eksternal, terutama ketika perubahan besar menyebabkan inkompatibilitas yang signifikan antarversi. Berisi semua endpoint, bukan hanya endpoint yang dimodifikasi atau baru ditambahkan

Cabang Sprint: Digunakan secara internal oleh tim pengembangan, selaras dengan konsep "sprint" dalam pengembangan agile. Setiap sprint biasanya membuat cabang yang hanya mencakup endpoint baru atau yang dimodifikasi, tidak termasuk endpoint yang tidak berubah

Kasus Penggunaan#

Sorotan Fitur Versi API#

Kasus Penggunaan

Sorotan Fitur Versi API