Compartilhar via

Importar uma API OData

APLICA-SE A: todas as camadas do Gerenciamento de API

Este artigo mostra como importar um serviço compatível com OData como uma API no Gerenciamento de API.

Neste artigo, você aprenderá como:

  • Importar uma descrição de metadados OData usando o portal do Azure
  • Gerenciar o esquema OData no portal
  • Proteger a API OData

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:

    Captura de tela que mostra os serviços de Gerenciamento de API nos resultados da pesquisa.

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

    Captura de tela que mostra uma instância de Gerenciamento de API na página de serviços do Gerenciamento de API.

Importar metadados do OData

  1. No menu à esquerda, selecione APIs>e, em seguida, selecione + Adicionar API.

  2. Em Criar a partir da definição, selecione OData:

    Captura de tela da criação de uma API com base em uma descrição OData no portal.

  3. Insira as configurações de API. Você pode atualizar suas configurações mais tarde acessando a guia Configurações da API.

    1. Na especificação OData, insira um URL para o endpoint de metadados do OData. Esse valor normalmente é a URL para a raiz do serviço, acrescentada com /$metadata. Como alternativa, selecione um arquivo XML OData local a ser importado.

    2. Insira configurações adicionais para configurar sua API. Essas configurações são explicadas no tutorial Importar e publicar sua primeira API.

  4. Selecione Criar.

    A API é adicionada à lista de APIs. Os conjuntos de entidades e as funções expostas na descrição de metadados do OData são exibidos na guia Conjuntos de entidades e funções da API.

    Captura de tela que mostra conjuntos e funções de entidade OData.

Atualizar o esquema OData

Você pode acessar um editor no portal para exibir o esquema da API OData. Se a API for alterada, você também poderá atualizar o esquema da API na Administração de APIs a partir de um arquivo ou de um ponto de extremidade do serviço OData.

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

  2. No menu à esquerda, selecione APIs e, em seguida, selecione sua API OData.

  3. Na guia Conjuntos de entidades e funções, selecione o menu de contexto (…) ao lado de um conjunto de entidades ou de uma função e escolha Editar.

    Captura de tela que mostra o local do comando Editar.

  4. Examine o esquema. Se você quiser atualizá-lo, selecione Atualizar do arquivo ou Atualizar esquema do ponto de extremidade.

    Captura de tela do editor de esquema de uma API OData.

Teste sua API OData

  1. No menu à esquerda, selecione APIs e, em seguida, selecione sua API OData.

  2. Na guia Conjuntos de entidades e funções, selecione o menu de contexto (…) ao lado de um conjunto de entidades ou de uma função e escolha Testar.

    Captura de tela que mostra o comando Teste.

  3. No console de teste, insira parâmetros de modelo, parâmetros de consulta e cabeçalhos para o teste e selecione Testar. Para obter mais informações sobre como testar APIs no portal, consulte Testar a nova API no portal.

Proteger a sua API OData

Proteja sua API OData aplicando políticas de autenticação e autorização existentes e uma política de validação OData para proteger contra ataques por meio de solicitações de API OData.

Dica

No portal, configure políticas para sua API OData na guia Políticas de API .

Acrescentar outras APIs

Você pode compor uma API a partir de APIs que são disponibilizadas por diferentes serviços, incluindo:

  • Uma especificação do OpenAPI
  • Uma API SOAP
  • Uma API do GraphQL
  • Um aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Azure Functions
  • Aplicativo Lógico do Azure
  • Azure Service Fabric

Observação

Quando você importa uma API, as operações são acrescentadas à API atual.

Para acrescentar uma API a uma API existente:

  1. Acesse sua instância de Gerenciamento de API do Azure no portal do Azure:

    Captura de tela que mostra a página Serviços de Gerenciamento de API.

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

    Captura de tela que mostra a seleção de APIs na página Visão geral.

  3. Selecione as reticências (...) próximas à API na qual deseja acrescentar outra API.

  4. Selecione Importar no menu suspenso:

    Captura de tela que mostra o comando Importar.

  5. Selecione um serviço de onde será importada a API.

Conteúdo relacionado

  • Last updated on