Импорт и публикация первого APIImport and publish your first API

В этом руководстве показано, как импортировать API серверной части "Спецификация OpenAPI", расположенный по адресу https://conferenceapi.azurewebsites.net?format=json.This tutorial shows how to import an "OpenAPI specification" backend API residing at https://conferenceapi.azurewebsites.net?format=json. Этот API серверной части предоставляется корпорацией Майкрософт. Он размещен в Azure.This backend API is provided by Microsoft and hosted on Azure.

Когда API серверной части будет импортирован в службу управления API, этот API будет использоваться как фасад для API серверной части.Once the backend API is imported into API Management (APIM), the APIM API becomes a facade for the backend API. Когда вы импортируете API серверной части, исходный API и API службы управления API являются идентичными.At the time you import the backend API, both the source API and the APIM API are identical. Служба управления API позволяет настраивать фасад согласно вашим потребностям, не используя API серверной части.APIM enables you to customize the facade according to your needs without touching the backend API. Дополнительные сведения см. в статье Transform and protect your API (Преобразование и защита API).For more information, see Transform and protect your API.

Из этого руководства вы узнаете, как выполнять следующие задачи:In this tutorial, you learn how to:

  • импорт API;Import your first API
  • проверка API на портале Azure;Test the API in the Azure portal
  • проверка API на портале разработчика.Test the API in the Developer portal

Новый API

Предварительные требованияPrerequisites

Перейдите к экземпляру службы управления API.Go to your API Management instance

Переход к экземпляру службы управления API

  1. Войдите на портале Azure.Sign in to the Azure portal.

  2. Выбор пункта Все службы.Select All services.

  3. В поле поиска введите api management.In the search box, enter api management.

  4. В результатах поиска щелкните Службы управления API.In the search results, select API Management services.

  5. Выберите экземпляр службы управления API.Select your API Management service instance.

Совет

Добавьте службу управления API в избранное на портале Azure. Для этого щелкните звезду.To add API Management to your favorites in the Azure portal, select the star.

Значок службы управления API(The API Management icon (Значок службы управления API) появится на портале в меню слева.) now appears in the left menu in the portal.

Импорт и публикация API серверной части Import and publish a backend API

В этом разделе показано, как импортировать и опубликовать API серверной части "Спецификация OpenAPI".This section shows how to import and publish an OpenAPI specification backend API.

  1. Выберите Интерфейсы API в разделе УПРАВЛЕНИЕ API.Select APIs from under API MANAGEMENT.

  2. Выберите Спецификация OpenAPI в списке и щелкните Полная во всплывающем окне.Select OpenAPI specification from the list and click Full in the pop-up.

    Создание API

    Можно задать значения API во время создания или позже, перейдя на вкладку Параметры. Красная звездочка рядом с полем указывает на то, что поле является обязательным.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.

    Используйте значения из таблицы ниже для создания первого API.Use the values from the table below to create your first API.

    ПараметрSetting ЗначениеValue ОПИСАНИЕDescription
    Спецификация OpenAPIOpenAPI Specification https://conferenceapi.azurewebsites.net?format=json Определяет службу, которая реализует API-интерфейс.References the service implementing the API. Портал управления API направит запросы по этому адресу.API management forwards requests to this address.
    Отображаемое имяDisplay name Demo Conference APIDemo Conference API Если нажать клавишу табуляции после ввода URL-адреса службы, служба управления API заполнит это поле информацией из объекта json.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Это имя отображается на портале разработчика.This name is displayed in the Developer portal.
    ИмяName demo-conference-apidemo-conference-api Содержит уникальное имя API.Provides a unique name for the API.
    Если нажать клавишу табуляции после ввода URL-адреса службы, служба управления API заполнит это поле информацией из объекта json.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    ОписаниеDescription Необязательное описание API.Provide an optional description of the API. Если нажать клавишу табуляции после ввода URL-адреса службы, служба управления API заполнит это поле информацией из объекта json.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Схема URL-адресовURL scheme HTTPSHTTPS Определяет, какие протоколы можно использовать для доступа к этому API.Determines which protocols can be used to access the API.
    Суффикс URL-адреса APIAPI URL suffix conferenceconference Этот суффикс добавляется к основному URL-адресу службы управления API.The suffix is appended to the base URL for the API management service. API Management отличает интерфейсы API по их суффиксу. Следовательно, суффикс должен быть уникальным для каждого API для заданного издателя.API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.
    ПродуктыProducts UnlimitedUnlimited Продуктами называют ассоциации из одного или нескольких API.Products are associations of one or more APIs. Вы можете объединить в продукте несколько API и предлагать их разработчикам через портал разработчика.You can include a number of APIs into a Product and offer them to developers through the developer portal.
    Чтобы опубликовать API, его нужно связать с определенным продуктом (в этом примере — с продуктом Unlimited).You publish the API by associating the API with a product (in this example, Unlimited). Чтобы добавить этот новый API в продукт, введите имя продукта (это можно сделать позже на странице Параметры).To add this new API to a product, type the product name (you can also do it later from the Settings page). Этот шаг можно повторить несколько раз, чтобы добавить API в несколько продуктов.This step can be repeated multiple times to add the API to multiple products.
    Чтобы получить доступ к API, разработчикам необходимо сначала подписаться на продукт.To get access to the API, developers must first subscribe to a product. После этого они получат ключ подписки, который подходит для любого API в этом продукте.When they subscribe, they get a subscription key that is good for any API in that product.
    Создавая экземпляр службы управления API, вы автоматически становитесь его администратором. Поэтому вы будете подписаны на все продукты.If you created the APIM instance, you are an administrator already, so you are subscribed to every product.
    По умолчанию каждый экземпляр API управления поставляется с двумя демонстрационными продуктами: Starter и Unlimited.By default, each API Management instance comes with two sample products: Starter and Unlimited.
    ТегиTags Теги для упорядочивания API.Tags for organizing APIs. Теги можно использовать для поиска, группирования или фильтрации.Tags can be used for searching, grouping, or filtering.
    Версия этого APIVersion this API? Дополнительные сведения об управлении версиями см. в статье Публикация нескольких версий API.For more information about versioning, see Publish multiple versions of your API

    Примечание

    Чтобы опубликовать API, его нужно связать с определенным продуктом.To publish the API, you must associate it with a product. Это можно сделать на странице Параметры.You can do it from the Settings page.

  3. Нажмите кнопку Создать.Select Create.

Совет

Если вы столкнулись с проблемами при импорте собственного определения API, см. список известных проблем и ограничений.If you are experiencing problems with import of your own API definition, see the list of known issues and restrictions.

Проверка нового API службы управления API на портале AzureTest the new APIM API in the Azure portal

Карта тестирования API

Операции можно вызывать непосредственно на портале Azure. Это удобный способ просмотра и проверки операций API.Operations can be called directly from the Azure portal, which provides a convenient way to view and test the operations of an API.

  1. Выберите API, созданный на предыдущем шаге (на вкладке Интерфейсы API).Select the API you created in the previous step (from the APIs tab).

  2. Откройте вкладку Тест.Press the Test tab.

  3. Щелкните GetSpeakers.Click on GetSpeakers. Эта страница отображает поля для параметров запроса (в нашем примере параметры не используются) и заголовки.The page displays fields for query parameters, in this case none, and headers. Один из заголовков, Ocp-Apim-Subscription-Key, содержит ключ подписки для продукта, связанного с этим API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Значение ключа будет заполнено автоматически.The key is filled in automatically.

  4. Нажмите кнопку Отправить.Press Send.

    Служба серверной части вернет ответ 200 — ОК и другие данные.Backend responds with 200 OK and some data.

Вызов операции с портала разработчика Call an operation from the developer portal

Также операции можно вызвать через портал разработчиков, чтобы проверить API.Operations can also be called from the Developer portal to test APIs.

  1. Перейдите на портал разработчика.Navigate to the Developer portal.

    Developer portal

  2. Выберите API, щелкните Demo Conference API и выберите GetSpeakers.Select APIS, click on Demo Conference API and then GetSpeakers.

    Эта страница отображает поля для параметров запроса (в нашем примере параметры не используются) и заголовки.The page displays fields for query parameters, in this case none, and headers. Один из заголовков, Ocp-Apim-Subscription-Key, содержит ключ подписки для продукта, связанного с этим API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Как создатель экземпляра службы управления API, вы автоматически являетесь администратором, поэтому сведения о ключе будут заполнены автоматически.If you created the APIM instance, you are an administrator already, so the key is filled in automatically.

  3. Щелкните Попробовать.Press Try it.

  4. Нажмите кнопку Отправить.Press Send.

    После вызова операции на портале разработчиков отображаются ответы.After an operation is invoked, the developer portal shows the responses.

Дальнейшие действия Next steps

Из этого руководства вы узнали, как выполнить следующие задачи:In this tutorial, you learned how to:

  • импорт API;Import your first API
  • проверка API на портале Azure;Test the API in the Azure portal
  • проверка API на портале разработчика.Test the API in the Developer portal

Перейдите к следующему руководству:Advance to the next tutorial: