Importar e publicar sua primeira APIImport and publish your first API

Este tutorial mostra como importar uma API de back-end da “especificação OpenAPI” residindo em 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. Esta API de back-end é fornecida pela Microsoft e hospedada no Azure.This backend API is provided by Microsoft and hosted on Azure.

Depois que a API de back-end é importada para o APIM (gerenciamento de API), a API do APIM torna-se uma fachada para a API de back-end.Once the backend API is imported into API Management (APIM), the APIM API becomes a facade for the backend API. Quando você importar a API de back-end, a API de origem e a API do APIM serão idênticas.At the time you import the backend API, both the source API and the APIM API are identical. O APIM permite que você personalize a fachada de acordo com suas necessidades sem mexer na API de back-end.APIM enables you to customize the facade according to your needs without touching the backend API. Para obter mais informações, consulte Transformar e proteger sua API.For more information, see Transform and protect your API.

Neste tutorial, você aprenderá como:In this tutorial, you learn how to:

  • Importar sua primeira APIImport your first API
  • Testar a API no Portal do AzureTest the API in the Azure portal
  • Testar a API no Portal do desenvolvedorTest the API in the Developer portal

Nova API

Pré-requisitosPrerequisites

Navegar até a instância de Gerenciamento de APIGo to your API Management instance

  1. No portal do Azure, pesquise e selecione Serviços de Gerenciamento de API.In the Azure portal, search for and select API Management services.

    Selecione Serviços de Gerenciamento de API

  2. Na tela Gerenciamento de API, selecione a sua instância de Gerenciamento de API.On the API Management screen, select your API Management instance.

    Selecione a sua instância de Gerenciamento de API

Importar e publicar uma API de back-end Import and publish a backend API

Esta seção mostra como importar e publicar uma API de back-end da especificação OpenAPI.This section shows how to import and publish an OpenAPI specification backend API.

  1. Selecione APIs em GERENCIAMENTO DE API.Select APIs from under API MANAGEMENT.

  2. Selecione Especificação do OpenAPI na lista e clique em Completo no pop-up.Select OpenAPI specification from the list and click Full in the pop-up.

    Criar uma API

    Você pode definir os valores da API durante a criação ou mais tarde, acessando a guia Configurações. O asterisco vermelho ao lado de um campo indica que ele é obrigatório.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.

    Use os valores da tabela abaixo para criar sua primeira API.Use the values from the table below to create your first API.

    ConfiguraçãoSetting ValorValue DESCRIÇÃODescription
    Especificação OpenAPIOpenAPI Specification https://conferenceapi.azurewebsites.net?format=json Referencia o serviço que implementa a API.References the service implementing the API. O gerenciamento de API envia as solicitações para esse endereço.API management forwards requests to this address.
    Nome de exibiçãoDisplay name API de Conferência de DemonstraçãoDemo Conference API Se você pressionar Tab depois de inserir a URL do serviço, o APIM preencherá esse campo com base no que está no json.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Esse nome é exibido no Portal do desenvolvedor.This name is displayed in the Developer portal.
    NomeName demo-conference-apidemo-conference-api Fornece um nome exclusivo para a API.Provides a unique name for the API.
    Se você pressionar Tab depois de inserir a URL do serviço, o APIM preencherá esse campo com base no que está no json.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    DescriçãoDescription Forneça uma descrição opcional da API.Provide an optional description of the API. Se você pressionar Tab depois de inserir a URL do serviço, o APIM preencherá esse campo com base no que está no json.If you press tab after entering the service URL, APIM will fill out this field based on what is in the json.
    Esquema de URLURL scheme HTTPSHTTPS Determina quais protocolos podem ser usados para acessar a API.Determines which protocols can be used to access the API.
    Sufixo da URL da APIAPI URL suffix conferenceconference O sufixo é acrescentado à URL base do serviço de gerenciamento de API.The suffix is appended to the base URL for the API management service. O Gerenciamento de API diferencia as APIs pelo sufixo e, portanto, o sufixo deve ser único para cada API para um editor específico.API Management distinguishes APIs by their suffix and therefore the suffix must be unique for every API for a given publisher.
    ProdutosProducts IlimitadoUnlimited Os produtos são associações de uma ou mais APIs.Products are associations of one or more APIs. É possível incluir várias APIs em um produto e oferecê-las aos desenvolvedores por meio do portal do desenvolvedor.You can include a number of APIs into a Product and offer them to developers through the developer portal.
    Você publica a API associando-a a um produto (neste exemplo, Ilimitado).You publish the API by associating the API with a product (in this example, Unlimited). Para adicionar essa nova API a um produto, digite o nome do produto (você também pode fazer isso posteriormente, na página Configurações).To add this new API to a product, type the product name (you can also do it later from the Settings page). Esta etapa pode ser repetida várias vezes para adicionar a API a vários produtos.This step can be repeated multiple times to add the API to multiple products.
    Para obter acesso à API, os desenvolvedores devem, primeiro, inscrever-se em um produto.To get access to the API, developers must first subscribe to a product. Com a assinatura, eles obtêm uma chave de assinatura que funciona para qualquer API no produto.When they subscribe, they get a subscription key that is good for any API in that product.
    Se você criou a instância do APIM, já é um administrador e, portanto, está inscrito em cada produto.If you created the APIM instance, you are an administrator already, so you are subscribed to every product.
    Por padrão, cada instância de Gerenciamento de API é fornecida com dois produtos função Web: Starter e Ilimitado.By default, each API Management instance comes with two sample products: Starter and Unlimited.
    MarcasTags Marcas para organizar APIs.Tags for organizing APIs. As marcas podem ser usadas para pesquisa, agrupamento ou filtragem.Tags can be used for searching, grouping, or filtering.
    Controlar a versão desta API?Version this API? Para obter mais informações sobre o controle de versão, consulte Publicar várias versões de sua APIFor more information about versioning, see Publish multiple versions of your API

    Observação

    Para publicar a API, você deve associá-la a um produto.To publish the API, you must associate it with a product. É possível fazer isso na página Configurações.You can do it from the Settings page.

  3. Selecione Criar.Select Create.

Dica

Se você estiver tendo problemas com a importação de sua própria definição de API, veja a lista de problemas e restrições conhecidos.If you are experiencing problems with import of your own API definition, see the list of known issues and restrictions.

Testar a nova API do APIM no portal do AzureTest the new APIM API in the Azure portal

Testar mapa de API

As operações podem ser chamadas diretamente do portal do Azure, o que oferece uma maneira fácil de exibir e testar as operações de uma 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. Selecione a API que você criou na etapa anterior (na guia APIs).Select the API you created in the previous step (from the APIs tab).

  2. Pressione a guia Testar.Press the Test tab.

  3. Clique em GetSpeakers.Click on GetSpeakers. A página exibe campos para parâmetros de consulta, nesse caso, não há nenhum, e cabeçalhos.The page displays fields for query parameters, in this case none, and headers. Um dos cabeçalhos é "Ocp-Apim-Subscription-Key", para a chave de assinatura do produto que está associado a essa API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. A chave é preenchida automaticamente.The key is filled in automatically.

  4. Pressione Enviar.Press Send.

    O back-end responde com 200 OK e alguns dados.Backend responds with 200 OK and some data.

Chamar uma operação no portal do desenvolvedor Call an operation from the developer portal

As operações também podem ser chamadas do Portal do desenvolvedor para testar APIs.Operations can also be called from the Developer portal to test APIs.

  1. Navegue até o portal do Desenvolvedor.Navigate to the Developer portal.

    Portal do desenvolvedor

  2. Selecione APIS, clique em API de Conferência de Demonstração e então em GetSpeakers.Select APIS, click on Demo Conference API and then GetSpeakers.

    A página exibe campos para parâmetros de consulta, nesse caso, não há nenhum, e cabeçalhos.The page displays fields for query parameters, in this case none, and headers. Um dos cabeçalhos é "Ocp-Apim-Subscription-Key", para a chave de assinatura do produto que está associado a essa API.One of the headers is "Ocp-Apim-Subscription-Key", for the subscription key of the product that is associated with this API. Se você criou a instância do APIM, já é um administrador e, portanto, a chave é preenchida automaticamente.If you created the APIM instance, you are an administrator already, so the key is filled in automatically.

  3. Pressione Experimentar.Press Try it.

  4. Pressione Enviar.Press Send.

    Depois de uma operação ser invocada, o portal do desenvolvedor mostra as respostas.After an operation is invoked, the developer portal shows the responses.

Próximas etapas Next steps

Neste tutorial, você aprendeu como:In this tutorial, you learned how to:

  • Importar sua primeira APIImport your first API
  • Testar a API no Portal do AzureTest the API in the Azure portal
  • Testar a API no Portal do desenvolvedorTest the API in the Developer portal

Prosseguir para o próximo tutorial:Advance to the next tutorial: