.png)
Sumber: ChatGPT
Perubahan Kecil yang Menjatuhkan Banyak Pihak
Mengganti nama sebuah atribut pada antarmuka sistem terlihat sebagai perubahan sepele. Di sisi tim pengembang, itu hanya beberapa baris. Di sisi pihak yang mengonsumsinya, itu bisa berarti aplikasi berhenti berfungsi.
Persoalannya menjadi lebih berat karena sebagian pengguna tidak bisa segera menyesuaikan diri. Aplikasi seluler yang sudah terpasang di perangkat pengguna tidak bisa dipaksa diperbarui seketika. Sistem mitra memiliki jadwal rilisnya sendiri yang tidak mengikuti jadwal Anda.
Karena itu antarmuka yang sudah dipakai pihak lain sebaiknya diperlakukan sebagai janji. Solusi web tech dengan integrasi API terbaik berangkat dari prinsip ini, yaitu bahwa perubahan harus dilakukan tanpa mengingkari janji yang sudah dibuat.
Aturan Dasar yang Menyelesaikan Sebagian Besar Masalah
Sebagian besar kerusakan integrasi bisa dihindari hanya dengan mematuhi satu aturan sederhana, yaitu menambah boleh, mengubah dan menghapus perlu perlakuan khusus.
Menambahkan atribut baru sebagai opsional aman dilakukan, karena sistem yang belum mengenalinya akan mengabaikannya tanpa masalah. Menambahkan nilai baru pada sebuah daftar pilihan juga umumnya aman, selama sistem penerima dirancang untuk tidak gagal saat menemui nilai yang belum dikenal.
Sebaliknya, mengganti nama atribut, mengubah tipe data, menjadikan atribut yang tadinya opsional sebagai wajib, atau menghapus atribut adalah perubahan yang akan merusak pihak lain. Semua ini perlu melalui mekanisme versi.
Aturan ini juga berlaku pada sisi penerima. Sistem yang dirancang untuk mengabaikan atribut yang tidak dikenalinya akan jauh lebih tahan terhadap perubahan di masa depan dibanding sistem yang memvalidasi struktur secara kaku.
Memilih Cara Menandai Versi
Ketika perubahan yang merusak memang tidak bisa dihindari, versi baru perlu disediakan berdampingan dengan yang lama.
Menyertakan versi di dalam alamat adalah cara yang paling umum karena paling mudah dipahami dan paling ramah terhadap penyimpanan sementara. Kelemahannya, alamat menjadi lebih panjang dan versi menjadi bagian dari identitas sumber daya.
Menyertakan versi pada penanda permintaan membuat alamat tetap bersih dan secara konseptual lebih tepat, karena versi sebenarnya menyangkut format representasi, bukan identitas sumber daya. Kelemahannya, lebih sulit diuji secara cepat dan kurang terlihat oleh yang mengonsumsinya.
Yang lebih penting daripada memilih salah satunya adalah konsistensi. Sistem yang memakai cara berbeda-beda pada bagian yang berbeda akan menyulitkan semua pihak yang mengintegrasikannya.
Menghentikan Versi Lama Tanpa Mengejutkan
Menyediakan versi baru hanya setengah dari pekerjaan. Bagian yang lebih menuntut kedisiplinan adalah menghentikan versi lama, karena tanpa itu jumlah versi yang harus dipelihara akan terus bertambah.
Penghentian yang tertib dimulai dengan pemberitahuan yang jelas, termasuk melalui penanda pada respons agar sistem yang masih memakai versi lama bisa mengetahuinya secara otomatis. Pemberitahuan ini disertai dokumentasi mengenai apa yang berubah dan bagaimana berpindah.
Setelah itu diberikan masa transisi yang wajar, yang panjangnya bergantung pada seberapa cepat pihak yang mengonsumsi bisa menyesuaikan diri. Untuk mitra eksternal dan aplikasi seluler, masa ini biasanya perlu dihitung dalam bulan, bukan minggu.
Selama masa transisi, penggunaan versi lama sebaiknya dipantau agar diketahui siapa yang masih memakainya. Mematikan versi lama tanpa mengetahui hal ini adalah cara tercepat menimbulkan gangguan yang tidak perlu.
Memastikan Janji Tidak Dilanggar Tanpa Sengaja
Kedisiplinan manusia tidak cukup untuk menjaga hal ini, terutama pada sistem yang dikerjakan banyak orang.
Karena itu pemeriksaan kesesuaian dijalankan otomatis pada setiap perubahan. Bila sebuah perubahan melanggar struktur yang sudah disepakati dengan pihak yang mengonsumsi, proses penerapan digagalkan sebelum sampai ke produksi.
Dokumentasi antarmuka juga dihasilkan otomatis dari kode, bukan ditulis terpisah, sehingga tidak ada jarak antara yang didokumentasikan dan yang sebenarnya berlaku. Dokumentasi yang ditulis manual hampir selalu tertinggal, dan dokumentasi yang tertinggal lebih berbahaya daripada tidak ada dokumentasi.
Kapan Pengelolaan Antarmuka Anda Perlu Dibenahi
Masalah pada pengelolaan antarmuka biasanya baru terasa setelah ada pihak yang terganggu.
|
Sinyal bahwa pengelolaan antarmuka Anda perlu dibenahi:
|
Langkah Memulai Bersama Sagara
Sagara memulai dari memetakan siapa saja yang mengonsumsi antarmuka Anda dan seberapa cepat mereka bisa menyesuaikan diri.
Konsultasi discovery untuk memahami ekosistem integrasi yang ada. Audit arsitektur untuk menilai kesiapan mekanisme versi dan pemeriksaan otomatis. Implementasi bertahap disertai penyusunan kebijakan penghentian versi yang bisa dipegang semua pihak.
Kesimpulan
Antarmuka yang sudah dipakai pihak lain adalah janji, dan mengubahnya secara sepihak akan selalu berujung pada gangguan yang sebenarnya bisa dihindari.
Solusi web tech dengan integrasi API terbaik memungkinkan inovasi tetap berjalan melalui versi baru, sementara pihak yang belum siap tetap terlayani oleh versi yang sudah teruji.
Sagara Technology menerapkan disiplin ini karena stabilitas integrasi menentukan kepercayaan mitra, dan kepercayaan itu jauh lebih sulit dipulihkan daripada dijaga.
