Mikro hizmet uygulamalarını yönetirken, her bir hizmetin sunduğu API arayüzlerini (yöntemler, parametreler, yollar ve dönüş türleri) kaynak koduna bakmadan anlamanız sıkça gerekir. Hizmet sözleşmeleri, mikro hizmet API'lerinizi OpenAPI belirtimine göre tanımlar. Mikro hizmet sistemleri bu sözleşmelere dayanarak çalışır. Bir uygulamayı Microservices Engine (MSE) üzerinde dağıttıktan sonra, uygulama içinde ek bağımlılık gerekmeden API ayrıntılarını doğrudan MSE konsolunda inceleyebilirsiniz.
Hizmet sözleşmeleri ayrıca, konsoldan herhangi bir API'yi doğrudan çağırmanıza olanak tanıyan hizmet testi özelliğinin temelini oluşturur.
Özellikler
Hizmet sözleşmeleri aşağıdaki üç özelliği sunar:
| Özellik | Açıklama |
|---|---|
| API sorgulama | Yöntem adları, parametre listeleri ve dönüş türleri dahil olmak üzere herhangi bir hizmet sağlayıcısı veya tüketicisi için API ayrıntılarını görüntüleyin. Spring Cloud hizmetleri için istek yöntemleri, istek yolları ve sınıf adları da kullanılabilir. |
| Swagger ek açıklamalarını ayrıştırma | Swagger, OpenAPI belirtiminin başlıca katkıda bulunanıdır ve API'leri tanımlamak için temel bir standart araçtır. Kodunuz Swagger veya OpenAPI ek açıklamaları kullanıyorsa, ayrıştırılan değerler sözleşme sayfasındaki Description sütununda görünür. Swagger 2.0: @ApiOperation, @ApiParam, @ApiImplicitParam. OpenAPI 3.0: @Operation, @Parameter. Ayrıştırma sonuçları Enterprise Distributed Application Service (EDAS) konsolundaki hizmet sözleşmesi sayfasında görüntülenir. |
| Hizmet testi | Hizmet sözleşmesi aracılığıyla toplanan parametre ve yöntem bilgilerini kullanarak, konsoldan doğrudan herhangi bir API yöntemini veya yolunu test edin. |
Hizmet sözleşmesini görüntüleme
MSE konsoluna giriş yapın ve üst gezinme çubuğundan bir bölge seçin.
Sol gezinme bölmesinde Microservices Governance > Service query öğelerini seçin.
-
Service query sayfasında hedef hizmeti bulun ve adına tıklayın.
Belirli bir hizmeti bulmak için sayfanın üst kısmındaki arama alanlarını kullanın. Aşağıdaki ölçütlere göre bulanık arama yapabilirsiniz:
Filtre Kullanım durumu Service name Tam veya kısmi hizmet adına göre arama yapın IP address Bir hizmet örneğinin IP adresine göre arama yapın Application name Dağıtılan uygulamanın adına göre arama yapın -
Service details panelinde sözleşme bilgilerini gözden geçirin. Panel aşağıdaki bölümleri içerir:
Bölüm Görüntülenen bilgiler Basic Information Hizmet hakkındaki genel meta veriler service provider Sağlayıcı tarafı arayüz ayrıntıları service consumer Tüketici tarafı arayüz ayrıntıları Interface metadata Hizmet arayüzü ile ilişkili meta veriler Metadata Metadata Hizmet hakkındaki ek meta veriler Hizmetiniz Swagger ek açıklamaları kullanıyorsa, ayrıştırılan ek açıklama değerleri Method Name/Description ve Parameters/Description sütunlarında görünür.