Öğretici: İlk API’nizi içeri aktarma ve yayımlama

APPLIES TO: Tüm API Yönetimi katmanları

Bu öğreticide, JSON biçiminde bir OpenAPI belirtimi arka uç API'sini Azure API Management içeri aktarma işlemi gösterilmektedir. Bu örnekte open source Petstore API içeri aktaracaksınız.

Tip

API ekipleri bu özelliği çalışma alanlarında kullanabilir. Çalışma alanları, API'lere yalıtılmış yönetim erişimi sağlar ve kendi API çalışma zamanı ortamlarına sahip olurlar.

Arka uç API'sini API Management içeri aktardığınızda, API Management API'niz arka uç API'sinin ağ geçidi olur. Arka uç API'sini değiştirmeden ağ geçidini API Management gereksinimlerinize göre özelleştirebilirsiniz. Daha fazla bilgi için bkz. API’nizi dönüştürme ve koruma.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

  • API'yi API Management içeri aktarma
  • API ayarlarını görüntüleme ve değiştirme
  • API'yi Azure portalında test edin.
  • API isteklerini API Management aracılığıyla yönlendirme

İçeri aktarma işleminden sonra API'yi Azure portal yönetebilirsiniz.

Portaldaki API Management yeni API'nin ekran görüntüsü.

Önkoşullar

API Management örneğine gitme

  1. Azure portalındaAPI Management hizmetlerini arayın ve seçin:

    Arama sonuçlarında API Management hizmetleri gösteren ekran görüntüsü.

  2. API Management services sayfasında API Management örneğinizi seçin:

    API Management hizmetleri sayfasında API Management bir örneği gösteren ekran görüntüsü.

Arka uç API’sini içeri aktarma ve yayımlama

Bu bölümde, bir OpenAPI belirtimi arka uç API’sinin nasıl içeri aktarılacağı ve yayımlanacağı gösterilmektedir.

  1. API Management örneğinizde kenar çubuğu menüsündeki APIs altında APIs öğesini seçin.

  2. OpenAPI kutucuğunu seçin.

  3. OpenAPI belirtiminden oluştur penceresinde Tam seçin.

  4. Aşağıdaki tabloda yer alan değerleri girin.

    Oluşturma sırasında veya daha sonraki sürümlerde Ayarlar sekmesine giderek API değerlerini ayarlayabilirsiniz.

    Portalda API oluşturma işleminin ekran görüntüsü.

    Setting Value Açıklama
    OpenAPI belirtimi https://petstore3.swagger.io/api/v3/openapi.json -veya- https://petstore.swagger.io/v2/swagger.json API'yi uygulayan arka uç hizmetini ve API'nin desteklediği işlemleri belirtir.

    Arka uç hizmeti URL'si daha sonra API'nin Ayarlar sayfasında Web hizmeti URL'si olarak görünür.

    İçeri aktarma işleminden sonra belirtime işlem ekleyebilir, düzenleyebilir, yeniden adlandırabilir veya silebilirsiniz.
    sorgu parametrelerini işlem şablonlarına ekleme Seçili (varsayılan) Belirtimdeki gerekli sorgu parametrelerinin API Management şablon parametreleri olarak içeri aktarılıp aktarılmayacağını belirtir.
    Görüntü adı OpenAPI belirtimi URL'sini girdikten sonra API Management bu alanı JSON'a göre doldurur. Geliştirici portalında görüntülenen ad.
    Name OpenAPI belirtimi URL'sini girdikten sonra API Management bu alanı JSON'a göre doldurur. API için benzersiz bir ad.
    Açıklama OpenAPI belirtimi URL'sini girdikten sonra API Management bu alanı JSON'a göre doldurur. API'nin isteğe bağlı açıklaması.
    URL düzeni HTTPS API'ye erişim sağlayabilen protokoller hangileridir?
    API URL uzantısı petstore API Management hizmetinin temel URL'sine eklenen eklenti. API Management, API'leri son eklerine göre ayırt eder ve yönlendirir; bu nedenle, her API için sonek, belirli bir yayıncıya ait benzersiz olmalıdır. API Management'in istekleri nasıl yönlendirdiği hakkında daha fazla bilgi edinin.
    Etiketler Arama, gruplandırma veya filtreleme için API'leri düzenlemeye yönelik etiketler.
    Ürünler Sınırsız Bir veya daha fazla API'nin ilişkisi. Belirli katmanlarda API Management örnek iki örnek ürünle birlikte gelir: Starter ve Unlimited. API'yi bir ürünle ilişkilendirerek geliştirici portalında bir API yayımlayabilirsiniz.

    Bir ürüne çeşitli API'ler ekleyebilir ve geliştirici portalı aracılığıyla geliştiricilere ürün abonelikleri sunabilirsiniz. Bu API'yi başka bir ürüne eklemek için ürün adını yazın veya seçin. API'yi birden çok ürüne eklemek için bu adımı yineleyin. Daha sonra Ayarlar sayfasından da ürünlere API'ler ekleyebilirsiniz.

    Ürünler hakkında daha fazla bilgi için bkz . Ürün oluşturma ve yayımlama.
    Ağ geçitleri Managed API'yi kullanıma sunan API ağ geçitleri. Bu alan yalnızca Geliştirici ve Premium katman hizmetlerinde kullanılabilir.

    Managed API Management hizmetinde yerleşik olarak bulunan ve microsoft tarafından Azure barındırılan ağ geçidini gösterir. Kendi sunucularınızda barındırılan ağ geçitleri yalnızca Premium ve Geliştirici hizmet katmanlarında kullanılabilir. Bunları şirket içinde veya diğer bulutlarda dağıtabilirsiniz.

    Herhangi bir ağ geçidi seçmezseniz API kullanılamaz ve API istekleriniz başarılı olmaz.
    Bu API'yi sürümlendir? Seç veya seçimi kaldır Daha fazla bilgi için bkz . API'nizin birden çok sürümünü yayımlama.

  5. API'nizi oluşturmak için Oluştur'u seçin.

API tanımını içeri aktarırken sorun yaşıyorsanız bkz. API içeri aktarma kısıtlamaları ve bilinen sorunlar.

API ayarlarını görüntüleme ve değiştirme

API'nizi içeri aktardıktan sonra, Azure portal ayarlarını ve işlemlerini görüntüleyebilir ve değiştirebilirsiniz.

  1. API Management örneğinizde kenar çubuğu menüsündeki APIs altında APIs öğesini seçin.

  2. İçeri aktarılan API'nizi seçin (örneğin, Swagger Petstore). Portalda API Management API ayarlarının ekran görüntüsü.

  3. OpenAPI belirtiminde API işlemlerini görüntülemek ve değiştirmek için Tasarım sekmesini seçin; örneğin:

    • URL, yöntem ve açıklama gibi işlem ayrıntıları
    • İstek ve yanıt tanımları
    • İstekleri ve yanıtları değiştirme ilkeleri

  4. API yapılandırma ayrıntılarını görüntülemek ve değiştirmek için Ayarlar sekmesini seçin; örneğin:

    • Görünen ad, ad ve açıklama
    • Web hizmeti URL'si (arka uç hizmeti), URL şeması ve API URL soneki
    • Ürünler, etiketler ve sürüm oluşturma
    • Abonelik gereksinimleri, güvenlik ve izleme gibi daha gelişmiş ayarlar

API Management öğreticilerini incelediğinizde API ayarlarını yapılandırma hakkında daha fazla bilgi edinebilirsiniz. API yapılandırmanızı özelleştirmek için istediğiniz zaman bu ayarları güncelleştirebilirsiniz.

Azure portal yeni API'yi test edin

API işlemlerini doğrudan Azure portal çağırabilirsiniz ve bu da işlemleri görüntülemek ve test etmek için kullanışlı bir yol sağlar. Portalın test konsolunda API'ler varsayılan olarak yerleşik all-access aboneliğinden bir anahtar kullanılarak çağrılır. Ayrıca, kapsamı bir ürün olarak belirlenmiş bir abonelik anahtarı kullanarak API çağrılarını test edebilirsiniz.

  1. API Management örneğinizde APIs>APIs>Swagger Petstore öğesini seçin.

  2. Test sekmesini seçin ve ardından Duruma göre Evcil Hayvan Bulur'a tıklayın. Sayfada Sorgu parametresi durumugösterilir. Mevcut değerlerden birini, örneğin bekleyen, seçin. Sorgu parametrelerini ve üst bilgileri buraya da ekleyebilirsiniz.

    HTTP isteği bölümünde, Ocp-Apim-Subscription-Key üst bilgisi sizin için otomatik olarak doldurulur ve "göz" simgesini seçtiğinizde bunu görebilirsiniz.

  3. Gönder'i seçin.

    Azure portal'da bir API'yi test etme ekran görüntüsü.

    Arka uç 200 OK ve bazı verilerle yanıt verir.

API Management istekleri nasıl yönlendirir?

API Management, API istemcileriniz ve arka uç hizmetleriniz arasında bir ağ geçidi işlevi görür. İstemci API Management tarafından yönetilen bir API'ye istekte bulunursa yönlendirme şu deseni izler:

İstemci isteği URL'si:
[API Management gateway URL] + [API URL suffix] + [Operation endpoint]

API Management şu düzeni kullanarak isteği arka uç hizmetine iletir:

Arka uç hizmeti URL'si:
[Web service URL] + [Operation endpoint]

Uyarı

yönlendirmenin düzgün çalışması için Operation uç noktası hem API Management API tanımında hem de arka uç hizmetinde aynı olmalıdır. Eşleşmeyen işlem uç noktaları 404 veya diğer yönlendirme hatalarıyla sonuçlanır.

Aşağıdaki tabloda, bu öğreticide kullanılan Petstore API örneği bağlamındaki her yönlendirme parametresi açıklanmaktadır:

Parametre Açıklama Örnek (Petstore API'si)
API Management ağ geçidi URL API Management örneğinizin temel URL'si https://apim-hello-world.azure-api.net
API URL uzantısı API Management içinde API'nizi tanımlayan benzersiz son ek (API oluşturma sırasında yapılandırılır) petstore
Web hizmeti URL'si OpenAPI belirtiminden türetilen arka uç hizmetinizin temel URL'si https://petstore3.swagger.io/api/v3
İşlem uç noktası Belirli bir işlem uç noktasının yolu (API belirtiminden türetilmiştir) /pet/findByStatus

Örnek: Duruma göre evcil hayvan bulma

Bu öğreticide içeri aktarılan Petstore API'sini kullanma:

  • Client API Yönetimi'ni çağırır:
    https://apim-hello-world.azure-api.net/petstore/pet/findByStatus?status=pending

    • API Management ağ geçidi URL'si: https://apim-hello-world.azure-api.net
    • API URL'si son eki: petstore
    • İşlem uç noktası: /pet/findByStatus

  • API Management arka tarafa yönlendirir:
    https://petstore3.swagger.io/api/v3/pet/findByStatus?status=pending

    • Web hizmeti URL'si: https://petstore3.swagger.io/api/v3
    • İşlem uç noktası: /pet/findByStatus (API Management tanımında olduğu gibi)

Sonraki adım

Ürün oluşturmayı ve yayımlamayı öğrenmek için sonraki öğreticiye geçin:

Ürün oluşturma ve yayımlama

  • Last updated on