API'yi el ile ekleme

UYGULANANLAR: Tüm API Management katmanları

Bu makalede, Azure API Management'a api'nin el ile nasıl ekleneceği gösterilmektedir. API'den mock yanıtlar oluşturmak istediğinizde, boş bir API oluşturun. Sahte API yanıtları oluşturma hakkında bilgi için bkz . Sahte API yanıtları.

Mevcut bir API'yi içeri aktarmak istiyorsanız, bu makalenin İlgili içerik bölümüne bakın.

Bu makalede, boş bir API oluşturmayı öğreneceksiniz. Arka uç API olarak httpbin.org (kamuya açık test hizmeti) belirtiyorsunuz.

Önkoşullar

API Management örneğinize gidin

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

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

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

    API Yönetimi hizmetleri sayfasında bir API Yönetimi örneğini gösteren ekran görüntüsü.

API oluşturma

  1. Soldaki menüde API'ler'in altında API'ler'i seçin.

  2. + API Ekle'yi seçin.

  3. HTTP kutucuğunu seçin:

    Azure portalındaki HTTP kutucuğunu gösteren ekran görüntüsü.

  4. Arka uç Web hizmeti URL'sini (örneğin, https://httpbin.org) ve API'nin diğer ayarlarını girin. İlk API'nizi İçe Aktar ve Yayınla eğitimi ayarları açıklar.

  5. Oluştur'u belirleyin.

Bu noktada, API Management'ta arka uç API'nizdeki işlemlere eşleyen hiçbir işleminiz yoktur. Arka uç üzerinden kullanıma sunulan ancak API Management aracılığıyla sunulmayan bir işlemi çağırırsanız 404 hatası alırsınız.

Not

Varsayılan olarak, bir API eklediğinizde, bir arka uç servisine bağlı olsa bile, API Yönetimi izin verene kadar hiçbir işlemi açığa çıkarmaz. Arka uç hizmetinizin bir işlemine izin vermek için arka uç işlemine eşleyen bir API Management işlemi oluşturun.

İşlem ekleme ve test etme

Bu bölümde, arka uç /get işlemiyle eşlemek için bir http://httpbin.org/get işlemin nasıl ekleneceği gösterilmektedir.

İşlem ekleme

  1. Önceki adımda oluşturduğunuz API’yi seçin.
  2. + İşlem ekle'yi seçin.
  3. URL'deGET'i seçin ve metin kutusuna /get yazın.
  4. Görünen ad alanına FetchData girin.
  5. Kaydet'i seçin.

İşlemi test et

Azure portalında işlemi test edin. (Geliştirici portalında da test edebilirsiniz.)

  1. Test sekmesini seçin.
  2. FetchData seçeneğini belirleyin.
  3. Gönder'i seçin.

İşlemin http://httpbin.org/get oluşturduğu yanıt HTTP yanıtı bölümünde görünür. Operasyonlarınızı dönüştürmek için API'nizi dönüştürme ve koruma bölümüne bakın.

Parametreli işlem ekleme ve test etme

Bu bölümde, nasıl parametre alan bir işlem ekleneceği gösterilir. Bu örnekte, işlemi http://httpbin.org/status/200 ile eşlersiniz.

İşlem ekleme

  1. Daha önce oluşturduğunuz API'yi seçin.
  2. Tasarım sekmesinde + İşlem ekle'yi seçin.
  3. URL'deGET'i seçin ve metin kutusuna /status/{code} yazın.
  4. Görünen ad alanına GetStatus yazın.
  5. Kaydet'i seçin.

İşlemi test et

Azure portalında işlemi test edin. (Geliştirici portalında da test edebilirsiniz.)

  1. Test sekmesini seçin.

  2. GetStatus seçeneğini belirleyin. Kodu200 girin.

  3. Gönder'i seçin.

    İşlemin http://httpbin.org/status/200 oluşturduğu yanıt HTTP yanıtı bölümünde görünür. Operasyonlarınızı dönüştürmek için API’nizi dönüştürme ve koruma bölümüne bakın.

Joker işlemi ekleyin ve test edin

Bu bölümde joker karakter işleminin nasıl ekleneceği gösterilmektedir. Bir joker işleminde, API isteği ile rastgele bir değer iletebilirsiniz. Önceki bölümlerde gösterildiği gibi ayrı GET işlemleri oluşturmak yerine bir joker karakter GET işlemi oluşturabilirsiniz.

Dikkat

Joker karakterle ilgili işlemi yapılandırırken dikkatli olun. Bu yapılandırma, bir API'yi belirli API güvenlik tehditlerine karşı daha savunmasız hale getirebilir.

İşlem ekleme

  1. Daha önce oluşturduğunuz API'yi seçin.
  2. Tasarım sekmesinde + İşlem ekle'yi seçin.
  3. URL'de GET'i seçin ve / metin kutusuna * girin.
  4. Görünen ad alanına WildcardGet girin.
  5. Kaydet'i seçin.

İşlemi test et

Azure portalında işlemi test edin. (Geliştirici portalında da test edebilirsiniz.)

  1. Test sekmesini seçin.

  2. WildcardGet'i seçin. Önceki bölümlerde test ettiğiniz GET işlemlerini deneyin veya desteklenen farklı bir GET işlemini deneyin.

    Örneğin, Şablon parametreleri'nde joker karakter (*) adının yanındaki değeri üst bilgi olarak değiştirin. İşlem, gelen isteğin HTTP üst bilgilerini döndürür.

  3. Gönder'i seçin.

    İşlemin http://httpbin.org/headers oluşturduğu yanıt HTTP yanıtı bölümünde görünür. İşlemlerinizi dönüştürmek istiyorsanız bkz. API'nizi dönüştürme ve koruma.

Not

Entegrasyonunu yaptığınız arka uç API'sinin, sonlarında eğik çizgiler olan endpoint URL'lerini nasıl işlediğini anlamak önemli olabilir. Daha fazla bilgi için bu API Yönetimi SSS bölümüne bakın.

Diğer API'leri ekleme

Farklı hizmetler tarafından kullanıma sunulan API'ler dışında bir API oluşturabilirsiniz, örneğin:

  • OpenAPI belirtimi
  • SOAP API'si
  • GraphQL API'si
  • Azure App Service'te barındırılan bir Web Uygulaması
  • Azure İşlevleri
  • Azure Logic Apps
  • Azure Service Fabric

Not

Bir API'yi içeri aktardığınızda, işlemler geçerli API'nize eklenir.

Api'yi var olan bir API'ye eklemek için:

  1. Azure portalında Azure API Management örneğine gidin:

    API Management hizmetleri sayfasını gösteren ekran görüntüsü.

  2. Genel Bakış sayfasında API'ler'i veya kenar çubuğu menüsünde APIAPI'leri'ni seçin>.

    Genel Bakış sayfasındaki API'lerin seçimini gösteren ekran görüntüsü.

  3. Eklemek istediğiniz başka bir API'nin yanındaki üç noktayı (...) seçin.

  4. Bağlam menüsünden İçeri Aktar'ı seçin:

    İçeri Aktar komutunu gösteren ekran görüntüsü.

  5. API'nin içeri aktarılacağı hizmeti seçin.