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

  • Makale
  • Okumak için 2 dakika

Bu öğreticide, OpenAPI Belirtimi arka uç API'sini JSON biçiminde Azure API Management. Microsoft, bu örnekte kullanılan arka uç API'sini sağlar ve üzerinde Azure'da https://conferenceapi.azurewebsites.net?format=json barındırr.

Arka uç API'sini API Management sonra API Management API'niz arka uç API'si için bir cephe haline gelir. Arka uç API'sini dokunmadan cepheyi API Management gereksinimlerinize göre özelleştirebilirsiniz. Daha fazla bilgi için bkz. API’nizi dönüştürme ve koruma.

Bu öğreticide şunların nasıl yapıldığını öğreneceksiniz:

  • Api'yi API Management
  • Azure portalında API’yi test etme

İçeri aktarmadan sonra API'yi Azure portal.

API Management'de yeni API

Önkoşullar

API Management örneğinize gidin

  1. Azure portal, API Management Hizmetleri' ni arayıp seçin.

    API Management hizmetleri seçin

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

    API Management örneğinizi seçin

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

Bu bölümde bir OpenAPI Belirtimi arka uç API'sini içeri aktarma ve yayımlama işlemi gösterir.

  1. Örnek örneğinizin sol gezinti API Management API'ler'i seçin.

  2. OpenAPI kutucuğunu seçin.

  3. OpenAPI belirtim penceresinde Tam'ı seçin.

  4. Aşağıdaki tabloda yer alan değerleri girin. Ardından API'nizi oluşturmak için Oluştur'a seçin.

    Api değerlerini oluşturma sırasında veya daha sonra Ayarlar ayarlayabilirsiniz.

    Bir API oluşturma

    Ayar Değer Açıklama
    OpenAPI belirtimi https: / /conferenceapi.azurewebsites.net?format=json API'yi uygulayan hizmet. API Management bu adrese iletir. Hizmetin genel olarak erişilebilen bir İnternet adresi üzerinde barındırılmaları gerekir.
    Görünen ad Önceki hizmet URL'sini girdikten API Management JSON'a göre bu alanı doldurur. Geliştirici portalında görüntülenen ad.
    Ad Önceki hizmet URL'sini girdikten API Management JSON'a göre bu alanı doldurur. API için benzersiz bir ad.
    Açıklama Önceki hizmet URL'sini girdikten API Management JSON'a göre bu alanı doldurur. API'nin isteğe bağlı açıklaması.
    URL düzeni HTTPS API'ye erişen protokoller.
    API URL’si soneki Konferans Hizmet için temel URL'ye eklenen son API Management. API Management API'leri soneklerine göre ayırt etmek için son ekin, verilen yayımcının her API'si için benzersiz olması gerekir.
    Etiketler ARAMA, gruplama veya filtreleme için API'leri düzenlemeye yönelik etiketler.
    Ürünler Sınırsız Bir veya daha fazla API'nin ilişkilendirmesi. Her API Management örneği iki örnek ürünle birlikte gelir: Starter ve Unlimited. Bu örnekte API'yi Sınırsız ürünle bağ bağlayacak şekilde bir API yayımlayacaksınız.

    Bir ürüne çeşitli API'ler dahil edebilirsiniz ve bunları geliştirici portalı aracılığıyla geliştiricilere 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ı tekrarlayın. Daha sonra uygulama sayfasından ürünlere API Ayarlar.

    Ürünler hakkında daha fazla bilgi için bkz. Ürün oluşturma ve yayımlama.
    Ağ geçitleri Yönetilen API'yi ortaya çıkaran API ağ geçitleri. Bu alan yalnızca Geliştirici ve Premium kullanılabilir.

    Yönetilen, azure'da Microsoft tarafından barındırılan API Management ağ geçidini gösterir. Kendi kendine 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ğıtın.

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

    Not

    API'yi API tüketicilerine yayımlamak için bir ürünle ilişkilendirmelisiniz.

  5. Oluştur’u seçin.

API tanımını içeri aktarmayla ilgili sorunları varsa bilinen sorunların ve kısıtlamaların listesine bakın.

Yeni API'yi Azure portal

API işlemlerini doğrudan Azure portal çağırabilirsiniz. Bu, işlemleri görüntülemek ve test etmek için kullanışlı bir yol sağlar.

  1. API Management örneğinizin sol gezintisinde API'ler Demo Konferans > API'si'ni seçin.

  2. Test sekmesini ve ardından GetSpeakers'ı seçin. Sayfada Sorgu parametreleri ve varsa Üst Bilgiler görüntülenir. Ocp-Apim-Subscription-Key, bu API ile ilişkili abonelik anahtarı için otomatik olarak doldurulur.

  3. Gönder’i seçin.

    Api'yi Azure portal

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

Sonraki adımlar

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:

  • İlk API’nizi içeri aktarma
  • Azure portalında API’yi test etme

Ürün oluşturma ve yayımlama hakkında bilgi edinmek için sonraki öğreticiye ilerleyin:

Ürün oluşturma ve yayımlama