İlk API’nizi içeri aktarma ve yayımlamaImport and publish your first API

Bu öğreticide, https://conferenceapi.azurewebsites.net?format=json konumunda bulunan bir "OpenAPI belirtimi" arka uç API’sinin nasıl içeri aktarılacağı gösterilmektedir.This tutorial shows how to import an "OpenAPI specification" backend API residing at https://conferenceapi.azurewebsites.net?format=json. Bu arka uç API’si, Microsoft tarafından sağlanır ve Azure’da barındırılır.This backend API is provided by Microsoft and hosted on Azure.

Arka uç API’si, API Yönetimi’ne (APIM) içeri aktarıldıktan sonra APIM API’si, arka uç API’si için bir cephe olur.Once the backend API is imported into API Management (APIM), the APIM API becomes a facade for the backend API. Arka uç API'sini içeri aktardığınızda hem kaynak API’si hem de APIM API’si aynı olur.At the time you import the backend API, both the source API and the APIM API are identical. APIM, arka uç API’sine dokunmadan ihtiyaçlarınıza göre cepheyi özelleştirmenize olanak sağlar.APIM enables you to customize the facade according to your needs without touching the backend API. Daha fazla bilgi için bkz. API’nizi dönüştürme ve koruma.For more information, see Transform and protect your API.

Bu öğreticide şunların nasıl yapıldığını öğreneceksiniz:In this tutorial, you learn how to:

  • İlk API’nizi içeri aktarmaImport your first API
  • Azure portalında API’yi test etmeTest the API in the Azure portal
  • Geliştirici portalında API’yi test etmeTest the API in the Developer portal

Yeni API

ÖnkoşullarPrerequisites

API Management örneğinize gidinGo to your API Management instance

API Management örneğine gitme

  1. Azure Portal oturum açın.Sign in to the Azure portal.

  2. Tüm Hizmetler’i seçin.Select All services.

  3. Arama kutusuna api management yazın.In the search box, enter api management.

  4. Arama sonuçlarından API Management hizmetlerini seçin.In the search results, select API Management services.

  5. API Management hizmet örneğinizi seçin.Select your API Management service instance.

İpucu

API Management’ı Azure portaldaki sık kullanılanlarınıza eklemek için yıldızı seçin.To add API Management to your favorites in the Azure portal, select the star.

API Management simgesi (The API Management icon (API Management simgesi) artık portalın sol tarafındaki menüde görünüyor.) now appears in the left menu in the portal.

Arka uç API’sini içeri aktarma ve yayımlama Import and publish a backend API

Bu bölümde, bir OpenAPI belirtimi arka uç API’sinin nasıl içeri aktarılacağı ve yayımlanacağı gösterilmektedir.This section shows how to import and publish an OpenAPI specification backend API.

  1. API YÖNETİMİ bölümünden API’ler öğesini seçin.Select APIs from under API MANAGEMENT.

  2. Listeden Openapı belirtimini seçin ve açılır pencerede tam ' ı tıklatın.Select OpenAPI specification from the list and click Full in the pop-up.

    Bir API oluşturma

    Ayarlar sekmesine giderek oluşturma sırasında veya sonrasında API değerlerini ayarlayabilirsiniz. Bir alanın yanındaki kırmızı yıldız, alanın zorunlu olduğunu belirtir.You can set the API values during creation or later by going to the Settings tab. The red star next to a field indicates that the field is required.

    İlk API'nizi oluşturmak için aşağıdaki tabloda yer alan değerleri kullanın.Use the values from the table below to create your first API.

    AyarSetting DeğerValue AçıklamaDescription
    OpenAPI BelirtimiOpenAPI Specification https://conferenceapi.azurewebsites.net?format=json API’yi uygulayan hizmete başvurur.References the service implementing the API. API Management istekleri bu adrese iletir.API management forwards requests to this address.
    Görünen adDisplay name Tanıtım Konferansı API’siDemo Conference API Hizmet URL’sini girdikten sonra sekme tuşuna basarsanız APIM, json'da ne olduğuna bağlı olarak bu alanı doldurur.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Bu ad, Geliştirici portalında görüntülenir.This name is displayed in the Developer portal.
    NameName demo-conference-apidemo-conference-api API için benzersiz bir ad sağlar.Provides a unique name for the API.
    Hizmet URL’sini girdikten sonra sekme tuşuna basarsanız APIM, json'da ne olduğuna bağlı olarak bu alanı doldurur.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    AçıklamaDescription API için isteğe bağlı bir açıklama sağlayın.Provide an optional description of the API. Hizmet URL’sini girdikten sonra sekme tuşuna basarsanız APIM, json'da ne olduğuna bağlı olarak bu alanı doldurur.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    URL düzeniURL scheme HTTPSHTTPS API’ye erişmek için hangi protokollerin kullanılabileceğini belirler.Determines which protocols can be used to access the API.
    API URL’si sonekiAPI URL suffix conferenceconference Sonek, API yönetimi hizmetinin temel URL’sinin sonuna eklenir.The suffix is appended to the base URL for the API management service. API Management API'leri soneklerine bakarak ayırt eder; dolayısıyla belirli bir yayımcıdaki her API için sonekin benzersiz olması gerekir.API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.
    ÜrünlerProducts SınırsızUnlimited Ürünler bir veya daha fazla API arasındaki ilişkilendirmelerdir.Products are associations of one or more APIs. Bir Ürüne birkaç API ekleyebilir ve bunları geliştirici portalı aracılığıyla geliştiricilere sunabilirsiniz.You can include a number of APIs into a Product and offer them to developers through the developer portal.
    API’yi bir ürünle ilişkilendirerek yayımlarsınız (bu örnekte, Sınırsız).You publish the API by associating the API with a product (in this example, Unlimited). Bu yeni API’yi bir ürüne eklemek için ürün adını yazın (Ayarlar sayfasından da bunu yapabilirsiniz).To add this new API to a product, type the product name (you can also do it later from the Settings page). Bu adım, API’yi birden fazla ürüne eklemek için birçok defa yinelenebilir.This step can be repeated multiple times to add the API to multiple products.
    API’ye erişim elde etmek için geliştiricilerin önce bir ürüne abone olması gerekir.To get access to the API, developers must first subscribe to a product. Abone olduklarında, ilgili üründeki tüm API’ler için geçerli olan bir abonelik anahtarı edinirler.When they subscribe, they get a subscription key that is good for any API in that product.
    APIM örneğini siz oluşturduysanız zaten bir yöneticisinizdir ve tüm ürünlere abone olmuşsunuz demektir.If you created the APIM instance, you are an administrator already, so you are subscribed to every product.
    Varsayılan olarak, her bir API Management örneği iki örnek ürün ile birlikte gelir: Başlangıç ve sınırsız.By default, each API Management instance comes with two sample products: Starter and Unlimited.
    EtiketlerTags API 'Leri düzenlemek için Etiketler.Tags for organizing APIs. Etiketler arama, gruplama veya filtreleme için kullanılabilir.Tags can be used for searching, grouping, or filtering.
    Bu API sürümünü mi kullanıyorsunuz?Version this API? Sürüm oluşturma hakkında daha fazla bilgi için bkz. API’nizin birden çok sürümünü yayımlamaFor more information about versioning, see Publish multiple versions of your API

    Not

    API’yi yayımlamak için bir ürünle ilişkilendirmeniz gerekir.To publish the API, you must associate it with a product. Ayarlar sayfasından bunu yapabilirsiniz.You can do it from the Settings page.

  3. Oluştur’u seçin.Select Create.

İpucu

Kendi API tanımınızı içeri aktarma konusunda sorun yaşıyorsanız bilinen sorunlar ve kısıtlamalar listesine bakın.If you are experiencing problems with import of your own API definition, see the list of known issues and restrictions.

Azure portalında yeni APIM API’sini test etmeTest the new APIM API in the Azure portal

API haritasını test etme

İşlemler doğrudan bir API’nin işlemlerini görüntülemek ve test etmek için kullanışlı bir yol sağlayan Azure portalından çağrılabilir.Operations can be called directly from the Azure portal, which provides a convenient way to view and test the operations of an API.

  1. Önceki adımda oluşturduğunuz API’yi seçin (API’ler sekmesinden).Select the API you created in the previous step (from the APIs tab).

  2. Test sekmesine basın.Press the Test tab.

  3. GetSpeakers seçeneğine tıklayın.Click on GetSpeakers. Sayfa, sorgu parametreleri alanlarını ve üst bilgileri görüntüler, ancak bu durumda bir alan yok.The page displays fields for query parameters, in this case none, and headers. Bu API ile ilişkilendirilmiş ürünün abonelik anahtarı için, üst bilgilerden biri "Ocp-Apim-Subscription-Key" üst bilgisidir.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Anahtar otomatik olarak doldurulur.The key is filled in automatically.

  4. Gönder’e basın.Press Send.

    Arka uç, 200 OK ve bazı verilerle yanıt verir.Backend responds with 200 OK and some data.

Geliştirici portalından işlem çağırma Call an operation from the developer portal

API’leri test etmek için Geliştirici portalından da işlemler çağrılabilir.Operations can also be called from the Developer portal to test APIs.

  1. Geliştirici portalına gidin.Navigate to the Developer portal.

    Geliştirici portalı

  2. API'ler’i seçip Tanıtım Konferansı API'si’ne ve ardından GetSpeakers’a tıklayın.Select APIS, click on Demo Conference API and then GetSpeakers.

    Sayfa, sorgu parametreleri alanlarını ve üst bilgileri görüntüler, ancak bu durumda bir alan yok.The page displays fields for query parameters, in this case none, and headers. Bu API ile ilişkilendirilmiş ürünün abonelik anahtarı için, üst bilgilerden biri "Ocp-Apim-Subscription-Key" üst bilgisidir.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. APIM örneğini siz oluşturduysanız zaten bir yöneticisinizdir ve anahtar otomatik olarak doldurulur.If you created the APIM instance, you are an administrator already, so the key is filled in automatically.

  3. Deneyin’e basın.Press Try it.

  4. Gönder’e basın.Press Send.

    Bir işlem çağrıldıktan sonra geliştirici portalı yanıtları gösterir.After an operation is invoked, the developer portal shows the responses.

Sonraki adımlar Next steps

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:In this tutorial, you learned how to:

  • İlk API’nizi içeri aktarmaImport your first API
  • Azure portalında API’yi test etmeTest the API in the Azure portal
  • Geliştirici portalında API’yi test etmeTest the API in the Developer portal

Sonraki öğreticiye ilerleyin:Advance to the next tutorial: