Partilhar via


Importar uma especificação de OpenAPI

APLICA-SE A: Todas as camadas de gerenciamento de API

Este artigo mostra como importar uma API de back-end "especificação OpenAPI" para o Gerenciamento de API do Azure usando várias ferramentas. O artigo também mostra como testar a API no Gerenciamento de API.

Neste artigo, vai aprender a:

  • Importar uma especificação OpenAPI usando o portal do Azure, a CLI do Azure ou o Azure PowerShell
  • Testar a API no Portal do Azure

Nota

As limitações de importação de API estão documentadas em restrições de importação de API e problemas conhecidos.

Pré-requisitos

Importar uma API de back-end

Neste exemplo, você importa a especificação OpenAPI para a API Petstore de código aberto, mas pode substituir uma especificação OpenAPI de sua escolha.

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.

  2. No menu à esquerda, selecione APIs>+ Add API.

  3. Em Criar a partir da definição, selecione OpenAPI.

    Captura de tela da criação de uma API a partir de uma especificação OpenAPI no portal.

  4. Insira as configurações da API. Você pode definir os valores durante a criação ou configurá-los mais tarde, indo para a guia Configurações . As configurações são explicadas no tutorial Importar e publicar sua primeira API .

  5. Selecione Criar.

Ver e editar a especificação OpenAPI

No portal, use o editor de especificações OpenAPI para exibir, validar ou editar a especificação da API que você importou.

Para usar o editor de especificações OpenAPI:

  1. No portal do Azure, navegue até sua instância de Gerenciamento de API.
  2. No menu à esquerda, em APIs, selecione APIs<>para suas operações de API>>Todos.
  3. Na guia Design, em Frontend, selecione OpenAPI Specification editor (ícone de lápis). Você pode abrir a especificação no formato JSON ou YAML.
  4. Revise ou edite a especificação conforme necessário. Salve suas alterações.

Validar em relação a um esquema de especificação OpenAPI

Você pode configurar políticas de validação do Gerenciamento de API para validar solicitações e respostas (ou elementos delas) em relação ao esquema em uma especificação OpenAPI. Por exemplo, use a política validate-content para validar o tamanho ou o conteúdo de uma solicitação ou corpo de resposta.

Teste a nova API no portal

As operações podem ser chamadas diretamente do portal, o que fornece uma maneira conveniente para os administradores visualizarem e testarem as operações de uma API.

  1. Selecione a API que criou no passo anterior.

  2. Selecione o separador Teste.

  3. Selecione uma operação. A página apresenta campos para os parâmetros de consulta e campos para os cabeçalhos.

    Nota

    No console de teste, o Gerenciamento de API preenche automaticamente um cabeçalho Ocp-Apim-Subscription-Key e configura a chave de assinatura da assinatura de acesso total interna. Essa chave permite o acesso a todas as APIs na instância de Gerenciamento de API. Opcionalmente, exiba o cabeçalho Ocp-Apim-Subscription-Key selecionando o ícone "olho" ao lado da Solicitação HTTP.

  4. Dependendo da operação, insira valores de parâmetros de consulta, valores de cabeçalho ou um corpo de solicitação. Selecione Enviar.

    Quando o teste é bem-sucedido, o back-end responde com um código de resposta HTTP bem-sucedido e alguns dados.

    Gorjeta

    Por padrão, o console de teste envia uma solicitação para o proxy CORS do Gerenciamento de API, que encaminha a solicitação para a instância de Gerenciamento de API, que a encaminha para o back-end. Este proxy usa o endereço IP público 13.91.254.72 e só pode alcançar pontos de extremidade públicos. Se quiser enviar uma solicitação diretamente do navegador para o serviço de Gerenciamento de API, selecione Ignorar proxy CORS. Use essa opção quando quiser usar o console de teste e seu gateway de Gerenciamento de API estiver isolado na rede ou não permitir tráfego do proxy CORS.

Para depurar uma API, consulte Tutorial: Depurar suas APIs usando o rastreamento de solicitações.

Anexar outras APIs

Você pode compor uma API de APIs expostas por diferentes serviços, incluindo:

  • Uma especificação OpenAPI
  • UMA API SOAP
  • Uma API GraphQL
  • Um Aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Aplicação de Função do Azure
  • Azure Logic Apps
  • Azure Service Fabric

Anexe uma API diferente à sua API existente usando as etapas a seguir.

Nota

Quando importar outra API, as operações são anexadas à API atual.

  1. Aceda à sua instância de API Management do Azure no portal do Azure.

    Captura de tela da navegação até a instância de Gerenciamento de API no portal.

  2. Selecione APIs na página Visão geral ou no menu à esquerda.

    Captura de tela da seleção de APIs na página Visão geral no portal.

  3. Clique em ... junto à API à qual quer anexar outra API.

  4. Selecione Importar no menu pendente.

    Selecione Importar

  5. Selecione um serviço a partir do qual quer importar uma API.

    Captura de ecrã a mostrar a seleção de um serviço no portal.

Próximos passos