API içeri aktarma ve yayımlama

  • 5 dakika

Bir API'yi API ağ geçidi aracılığıyla kullanıma sunmak için ilgili API'yi içeri aktarıp yayımlamanız gerekir.

Ayakkabı şirketi örneğinde NorthWind Shoes, belirli iş ortaklarının stok düzeylerini sorgulayabilmesini istiyor.

Burada bir API'yi Azure API Management'a aktarmayı ve BIR API'yi istemcilerin kullanımına sunmayı öğreneceksiniz.

API

API, kuruluşların belirli verileri geliştiricilerin veya iş ortaklarının kullanımına sunmasını sağlayan standart yöntemdir. Örneğin önceki alıştırmada, ürün ve stok bilgisi paylaşmak için bir API oluşturdunuz.

API'yi kullanılabilir duruma getirmek için API Management'a aktarmanız gerekir. Ardından şunları yapabilirsiniz:

  • API ağ geçidindeki görselleştirme araçlarını kullanarak API'nizi test etme.
  • İlkeleri kullanarak API erişimini yönetme.

API çerçeveleri

Birçok farklı API çerçevesi ve standardı vardır. API Management, API'leri içeri aktarmak için kullanabileceğiniz birçok seçenek sunar.

Tür Ayrıntılar
HTTP Boş bir API tanımıyla HTTP API'sini içeri aktarabilirsiniz. Ardından gerekli parametrelerin tamamını el ile belirtebilirsiniz.
WebSocket Arka uç WebSocket hizmetine geçiş ayarlama.
GraphQL Arka uç GraphQL hizmetine geçiş ayarlayın veya bir GraphQL şemasını içeri aktarıp özel alan çözümleyicileriyle yapay bir GraphQL API'sini oluşturun.
OpenAPI OpenAPI, RESTful API'leri için tüm uç noktaları ve işlemleri ve tüm giriş ve çıkış parametrelerini belgeleyen bir belirtimdir. Open API, eskiden Swagger olarak biliniyordu.
WADL Web Uygulaması Tanımlama Dili, HTTP tabanlı web hizmetlerinin XML tanımlamasıdır. WSDL'den daha basit ve daha basit bir biçimdir.
WSDL Web Hizmeti Tanımlama Dili, yalnızca HTTP değil tüm ağ hizmetlerinin XML tanımlamasıdır.

Api'leri birkaç arka uç Azure kaynağından da içeri aktarabilirsiniz.

Tür Ayrıntılar
Mantıksal Uygulama Mantıksal uygulamalar, iş akışlarını ve farklı veri kaynaklarıyla gerçekleştirilen tümleştirmeleri düzenlemek ve otomatikleştirmek için kullanılır.
App Service Azure'da bir uygulama hizmetinde barındırılan API.
İşlev Uygulaması Tetikleyiciler aracılığıyla çağrılabilen sunucusuz koddur.
Kapsayıcı Uygulaması Mikro hizmetler için sunucusuz kapsayıcılar.

Bir API’yi içeri aktarma

Azure API Management'a API aktarmak için kullanabileceğiniz birçok yöntem vardır.

Azure portalından API'ler öğesini ve ardından + API Ekle'yi seçin. İçeri aktarmak istediğiniz API türünü seçerek işe başlarsınız.

Screenshot of Azure portal showing API Management service with the APIs section highlighted and selected.

Ardından API belirtiminin bulunduğu URL'nin veya dosyanın bağlantısını ve API'nin adını belirtirsiniz. Burada OpenAPI içe aktarma işlemine örnek verilmiştir.

Screenshot of create from OpenAPI specification import settings with OpenAPI specification and display name fields highlighted.

Azure portalı, çok sayıda API'yi içeri aktarmak ve yapılandırmak için en verimli araç değildir. API yönetiminizin ölçeğini artırdıkça Azure CLI, Azure Resource Manager veya Bicep şablonları ya da Azure PowerShell gibi başka araçlara ihtiyacınız vardır. Örneğin, API ağ geçitlerini dağıtmak, ürünleri tanımlayıp yapılandırmak, API'leri içeri aktarmak ve kullanıcıları ve abonelikleri yönetmek için Azure PowerShell cmdlet'lerini kullanabilirsiniz.

Görselleştirme

İçeri aktarılan API'lerinizle verilerin nasıl işleneceğini görselleştirmek için API ağ geçidini kullanabilirsiniz. Veri kümeleriyle etkileşim kurabilir ve API'leriniz aracılığıyla parametre geçirebilirsiniz.

Yöneticiyseniz API'leri Azure portalında görselleştirebilirsiniz.

Screenshot of Azure portal API configuration showing a highlighted GET request test on an imported API.

İlkeler

İlkeler, yapılandırma ile bir API'nin davranışını değiştirmek için gelişmiş seçenekler sunar. Bunlar, bir API isteği veya yanıtı üzerinde sırayla yürütülen deyimlerin bir koleksiyonudur.

Popüler yapılandırmalar şunlardır:

  • XML'den JSON'a dönüştürme
  • Gelen çağrı sayısını sınırlamak için çağrı hızını sınırlama
  • Gelen ve giden üst bilgileri ayarlama.

API'lere farklı ilkeler uygulamak için Azure portalını kullanabilirsiniz. İlkeleri Tasarım sekmesinde görüntüleyebilirsiniz.

Screenshot of Azure portal showing API configuration for all operations with base policies highlighted for inbound, outbound, and backend sections.

Yeni ilkeler eklemek için Tasarım sekmesini de kullanabilirsiniz.

Screenshot of Azure portal showing inbound policy options for API configuration.

Ürün

Ürün, API'lerden oluşan bir koleksiyondur. API'leri birden fazla ürüne atayabilirsiniz. Örneğin NorthWindShoesPartners ürününün iş ortaklarınız için iki farklı API'de kullanıma sunulmasını istiyor olabilirsiniz:

Ürün NorthWindShoesPartners
API 1 Stok
API 2 Planlama

Tedarikçileriniz için yalnızca bir API'yi kullanıma sunmak isteyebilirsiniz:

Ürün NorthWindShoesSuppliers
API 1 Stok
API 2

İlke atayarak ürünlerinize farklı erişim kuralları, kullanım kotaları ve kullanım koşulları uygulanmasını sağlayabilirsiniz. Bu doğrultuda iş ortaklarınızın ve tedarikçilerinizin Stok API'nizde farklı erişim haklarına sahip olmasını istiyorsanız API'yi iki farklı ürüne atamanız gerekir.

API'leri bir ürünle ilişkilendirmek için Azure portalını kullanabilirsiniz.

Screenshot of Azure portal showing API Management with products section highlighted.

Tüketim dışındaki tüm fiyatlandırma katmanları için iki varsayılan ürün vardır: Starter ve Sınırsız. Eklenen API sayısı konusunda kısıtlamaya sahip olmayan Sınırsız ürünü, üretim API'lerinin yönetilmesi için tasarlanmıştır. İstediğiniz sayıda ürün oluşturabilirsiniz. Starter ürününün beş API çağrısı/dakika sınırı ve en fazla 100 API çağrısı/hafta vardır.