Pada artikel ini, kita akan melihat pendekatan untuk mengembangkan REST API berbasis kontrak.
Saat mengembangkan API REST yang baik, penting untuk memiliki layanan microser yang bagus. Pendekatan Kontrak Pertama akan membantu Anda mengembangkan kontrak yang baik sebelum diterapkan. Namun, itu tidak begitu sederhana!
Kamu akan belajar
- Apa pendekatan Kontrak Pertama untuk mengembangkan REST API?
- Apa manfaat dari pendekatan Kontrak Pertama?
- Apa kerugian dari pendekatan Kontrak Pertama?
- Kapan Anda menggunakan pendekatan Kontrak Pertama?
API SISA
Ini adalah artikel ketiga dari serangkaian artikel tentang REST API:
Konsep Layanan Web
Ada beberapa jenis layanan web, termasuk REST dan SOAP. Untuk setiap layanan ada:
- Penyedia layanan yang menyediakan layanan
- Konsumen layanan yang menggunakannya
Konsumen harus mengetahui perincian layanan yang disediakan. Untuk alasan ini, kontrak harus diselesaikan. Kontrak layanan mendefinisikan:
- Apa saja seluk beluk layanan ini?
- Di URL manakah layanan itu tersedia?
- Bagaimana cara mengirim otorisasi?
Pendekatan kontrak pertama
Dengan pendekatan "
Kontrak Pertama " (kontrak pertama), Anda pertama-tama menentukan kontrak dan kemudian mengimplementasikan layanan. Mari kita lihat sebuah contoh.
Wsdl
Mari kita lihat penggunaan WSDL, bahasa definisi layanan web. Ini adalah contoh penggunaan:
WSDL umumnya digunakan dengan layanan web SOAP / XML. Dalam hal ini, Anda biasanya mendefinisikan:
Apa yang dimaksud dengan kontrak?
Ketika kita mulai dengan menyimpulkan kontrak, kita mendefinisikan WSDL dan kemudian membaginya dengan konsumen kita. Semua ini dapat terjadi bahkan sebelum kami memperkenalkan layanan dan menyediakannya.
Kontrak memberi tahu konsumen bagaimana pertukaran permintaan dan respons diharapkan. Setelah kontrak selesai, penyedia layanan dapat bekerja untuk memberikan layanan yang konsisten dengan kontrak. Seorang konsumen layanan dapat bekerja mengembangkan aplikasi untuk penggunaannya.
Manfaat dari Pendekatan Pertama Kontrak
Tim dapat berkembang secara paralel
Karena pengkodean berbasis kontrak, penyedia layanan dan kelompok konsumen jelas memahami pendekatan dan rincian komunikasi. Karena itu, pengembangan dapat terjadi secara bersamaan.
Tim tahu apa yang diharapkan.
Karena pengkodean didasarkan pada kontrak, tim produsen dan konsumen memiliki gagasan tentang harapan satu sama lain. Akibatnya, jika pengujian antarkelompok tidak dimungkinkan karena tingkat perkembangan yang berbeda, perangkat lunak rintisan dapat digunakan untuk memodelkan perilaku pihak lain berdasarkan kontrak.
Kompatibilitas Lintas Platform
Karena parameter layanan hanya bergantung pada kontrak, struktur perangkat lunak yang sebenarnya digunakan untuk mengembangkan layanan tidak terlalu menjadi masalah. Penyedia layanan dan konsumen layanan dapat menggunakan teknologi berbeda.
Mengizinkan penggunaan ulang skema
Skema yang digunakan untuk menentukan kontrak layanan didefinisikan dengan baik dalam WSDL. Oleh karena itu, jika bagian dari layanan diulangi di layanan lain, maka skema yang sesuai juga dapat digunakan kembali.
Kerugian dari Pendekatan Pertama Kontrak
Diperlukan biaya dimuka tambahan
Sebagian besar biaya ini akan dipusatkan di sekitar perjanjian layanan. Anda harus memastikan bahwa kontrak didefinisikan dengan jelas dan tidak terlalu sering berubah.
Mekanisme untuk pembaruan dan pertukaran kontrak
Selama jangka waktu penggunaan layanan, jika Anda memperbarui kontrak, itu mempengaruhi semua pihak yang berkepentingan lainnya. Karena itu, harus ada mekanisme yang tepat untuk mentransfer perubahan ke konsumen yang berbeda.
Pada masalah ini ada
video penulis.
Ringkasan
Dalam artikel ini, kami membahas pendekatan Kontrak Pertama dalam konteks layanan web.
Bacaan tambahan
Pengembangan Aplikasi Cepat Dengan Pendekatan Pertama API Menggunakan Generator Open-APIMenerapkan Metodologi Desain API-Pertama