Kontrak layanan adalah deskripsi antarmuka layanan mikro berdasarkan spesifikasi OpenAPI. Sistem layanan mikro beroperasi sesuai dengan kontrak ini. Setelah menerapkan aplikasi, Anda tidak perlu memperkenalkan dependensi tambahan. Dengan menggunakan kontrak layanan, Anda dapat melihat informasi API seperti antarmuka layanan mikro dan jalurnya. Selain itu, Anda dapat memanfaatkan fitur seperti pengujian layanan untuk menanyakan dan menggunakan layanan secara efisien.
Informasi latar belakang
Kontrak layanan mencakup tiga fitur utama:
Permintaan API
Dengan menggunakan kontrak layanan, Anda dapat melihat informasi API penting dari penyedia layanan atau konsumen, termasuk metode, daftar parameter, dan tipe pengembalian. Jika Anda menggunakan layanan Spring Cloud, Anda juga dapat melihat detail seperti metode permintaan, jalur permintaan, dan nama kelas.
Penguraian Anotasi Swagger
Swagger merupakan kontributor utama dalam spesifikasi OpenAPI. Meskipun bukan satu-satunya alat yang mendukung spesifikasi ini, Swagger adalah alat standar dasar untuk mendeskripsikan API.
Kontrak layanan mendukung penguraian anotasi Swagger. Hasil penguraian ditampilkan di halaman kontrak layanan pada konsol Enterprise Distributed Application Service (EDAS).
Untuk Swagger 2.0, nilai anotasi seperti @ApiOperation, @ApiParam, dan @ApiImplicitParam diuraikan dan ditampilkan di kolom Description.
Untuk OpenAPI 3.0, nilai anotasi seperti @Operation dan @Parameter diuraikan dan ditampilkan di kolom Description.
Prasyarat Pengujian Layanan
Fitur pengujian layanan digunakan untuk menguji antarmuka atau jalur layanan berdasarkan informasi API yang dikumpulkan melalui kontrak layanan.
Prosedur
Masuk ke konsol MSE, lalu pilih wilayah di bilah navigasi atas.
Di panel navigasi sisi kiri, pilih .
Di halaman Service query, klik nama layanan yang ingin Anda lihat.
Jika terdapat banyak layanan, Anda dapat melakukan pencarian kabur berdasarkan Service name, IP address, atau Application name.
Di panel Service details, lihat Basic Information, service provider, service consumer, Interface metadata, dan Metadata Metadata dari antarmuka aplikasi.
Jika anotasi Swagger digunakan, informasi terkait akan ditampilkan di kolom Nama Metode/Deskripsi dan Parameter/Deskripsi.