Tutorial: Importar e publicar sua primeira API

Este tutorial mostra como importar uma API de back-end da Especificação OpenAPI em formato JSON para o Gerenciamento de API do Azure. A Microsoft fornece a API de back-end usada neste exemplo e a hospeda no Azure em https://conferenceapi.azurewebsites.net?format=json.

Após importar a API de back-end para o Gerenciamento de API, sua API do Gerenciamento de API se tornará uma fachada para a API de back-end. Você pode personalizar a fachada de acordo com suas necessidades no Gerenciamento de API sem mexer na API de back-end. Para obter mais informações, consulte Transformar e proteger sua API.

Neste tutorial, você aprenderá como:

  • Importar uma API para o Gerenciamento de API
  • Testar a API no Portal do Azure

Após a importação, você pode gerenciar a API no portal do Azure.

Nova API no Gerenciamento de API

Pré-requisitos

Navegar até a instância de Gerenciamento de API

  1. No portal do Azure, pesquise e selecione Serviços de Gerenciamento de API.

    Selecione Serviços de Gerenciamento de API

  2. Na página Serviços de Gerenciamento de API, selecione a sua instância de Gerenciamento de API.

    Selecione a sua instância de Gerenciamento de API

Importar e publicar uma API de back-end

Esta seção mostra como importar e publicar uma API de back-end da Especificação OpenAPI.

  1. No painel de navegação esquerdo de sua instância do Gerenciamento de API, selecione APIs.

  2. Selecione o bloco OpenAPI.

  3. Na janela Criar a partir da especificação de OpenAPI, selecione Completo.

  4. Insira os valores da tabela a seguir.

    Você pode definir os valores da API durante a criação ou mais tarde, acessando a guia Configurações.

    Criar uma API

    Configuração Valor Descrição
    Especificação OpenAPI https://conferenceapi.azurewebsites.net?format=json Especifica o serviço de back-end que implementa a API. O Gerenciamento de API envia as solicitações para esse endereço.

    A URL do serviço de back-end é exibida posteriormente como a URL do serviço Web na página Configurações da API.
    Nome de exibição Depois de inserir a URL de serviço anterior, o Gerenciamento de API preencherá esse campo com base no JSON. O nome exibido no portal do desenvolvedor.
    Nome Depois de inserir a URL de serviço anterior, o Gerenciamento de API preencherá esse campo com base no JSON. Um nome exclusivo para a API.
    Descrição Depois de inserir a URL de serviço anterior, o Gerenciamento de API preencherá esse campo com base no JSON. Uma descrição opcional da API.
    Esquema de URL HTTPS Quais protocolos podem acessar a API.
    Sufixo da URL da API conference O sufixo acrescentado à URL base do serviço de Gerenciamento de API. O Gerenciamento de API diferencia as APIs pelo sufixo; assim, o sufixo deve ser único para cada API para um editor específico.
    Marcas As marcas para organizar APIs para pesquisa, agrupamento ou filtragem.
    Produtos Ilimitado Associação de uma ou mais APIs. Cada instância de Gerenciamento de API é fornecida com dois produtos função Web: Starter e Ilimitado. Você publica uma API associando-a a um produto, Ilimitado neste exemplo.

    É possível incluir várias APIs em um produto e oferecê-las aos desenvolvedores por meio do portal do desenvolvedor. Para adicionar essa API a outro produto, digite ou selecione o nome dele. Repita essa etapa para adicionar a API a vários produtos. Você também pode adicionar APIs aos produtos mais tarde por meio da página Configurações.

    Para obter mais informações sobre os produtos, confira Criar e publicar um produto.
    Gateways Gerenciado Gateways de API que expõem a API. Esse campo está disponível somente nos serviços dos níveis Desenvolvedor e Premium.

    Gerenciado indica o gateway interno do serviço de Gerenciamento de API, que é hospedado pela Microsoft no Azure. Gateways auto-hospedados estão disponíveis apenas nas camadas de serviço Premium e Desenvolvedor. Você pode implantá-los localmente ou em outras nuvens.

    Se não houver gateway selecionado, a API não estará disponível e suas solicitações de API não terão sucesso.
    Controlar a versão desta API? Selecionar ou cancelar seleção Para obter mais informações, consulte Publicar várias versões de sua API.

    Observação

    Para publicar a API para consumidores de API, você deve associá-la a um produto.

  5. Selecione Criar para criar sua API.

Se você tiver problemas com a importação de uma definição de API, confira a lista de problemas e restrições conhecidos.

Testar a nova API no portal do Azure

Você pode chamar operações de API diretamente do portal do Azure, que oferece uma forma fácil de exibir e testar as operações.

  1. No painel de navegação esquerdo de sua instância do Gerenciamento de API, selecione APIs>Importar a API Conferência de Demonstração.

  2. Selecione a guia Testar e, em seguida, GetSpeakers. A página mostrará Parâmetros de consulta e Cabeçalhos, se houver. O Ocp-Apim-Subscription-Key é preenchido automaticamente para a chave de assinatura associada a esta API.

  3. Selecione Enviar.

    Testar API no portal do Azure

    O back-end responde com 200 OK e alguns dados.

Próximas etapas

Neste tutorial, você aprendeu a:

  • Importar sua primeira API
  • Testar a API no Portal do Azure

Vá para o próximo tutorial para aprender a criar e publicar um produto: