Partilhar via

Importar uma API OData

  • Artigo

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

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

Neste artigo, vai aprender a:

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

Pré-requisitos

  • Uma instância de gerenciamento de API. Se você ainda não tiver uma, conclua o seguinte início rápido: Criar uma instância de Gerenciamento de API do Azure.

  • Um serviço exposto como OData v2 ou v4.

Vá para a sua instância de Gestão de API

  1. No portal do Azure, procure e selecione serviços de Gerenciamento de API.

    Selecionar serviços de gerenciamento de API

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

    Selecione sua instância de Gerenciamento de API

Importar metadados OData

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

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

    Captura de tela da criação de uma API a partir de uma descrição do OData no portal.

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

    1. Na especificação OData, insira uma URL para um ponto de extremidade de metadados OData, normalmente a URL para a raiz do serviço, acrescentada com /$metadata. Como alternativa, selecione um arquivo OData XML local para importar.

    2. Insira as configurações restantes 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 funções que são expostos na descrição de metadados OData aparecem na guia Conjuntos de entidades e funções da API.

    Captura de tela de conjuntos de entidades OData e funções no portal.

Atualizar o esquema OData

Você pode acessar um editor no portal para visualizar o esquema OData da sua API. Se a API for alterada, você também poderá atualizar o esquema no Gerenciamento de API a partir de um arquivo ou de um ponto de extremidade de serviço OData.

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

  2. No menu à esquerda, selecione APIs> 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 função e selecione Editar.

    Captura de tela do menu de contexto para uma entidade OData definida no portal.

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

    Captura de tela do editor de esquema para OData API no portal.

Teste sua API OData

  1. No menu à esquerda, selecione APIs> 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 função e selecione Testar.

    Captura de tela da opção Testar no menu de contexto para uma entidade OData definida no portal.

  3. No console de teste, insira parâmetros de modelo, parâmetros de consulta e cabeçalhos para seu teste e selecione Testar. Saiba mais sobre como testar uma API no portal.

Proteja 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.

Gorjeta

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

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.