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

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

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

Navegar até a instância de Gerenciamento de API

1. No portal do Azure, pesquise e 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.

   

Importar metadados do OData

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

2. Em Criar com base na definição, selecione OData.

   

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 uma URL para um ponto de extremidade de metadados OData, normalmente a URL para a raiz do serviço, acrescentada de /$metadata. Como alternativa, selecione um arquivo XML OData local a ser importado.

   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 as funções expostas na descrição de metadados do OData são exibidos na guia Conjuntos de entidades e funções da API.

   

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 em Gerenciamento de API de um arquivo ou de um ponto de extremidade de serviço OData.

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

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

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.

   

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

   

Testar a API OData

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

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.

   

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

Proteger 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 protegê-la 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 de APIs expostas por diferentes serviços, incluindo:

• Uma especificação do OpenAPI
• Uma API SOAP
• Uma API da GraphQL
• Um aplicativo Web hospedado no Serviço de Aplicativo do Azure
• Aplicativo de Funções do Azure
• Aplicativos Lógicos do Azure
• Azure Service Fabric

Acrescente uma API diferente da API existente usando as etapas a seguir.

Observação

Ao importar outra API, as operações são acrescentadas à sua API atual.

1. Vá para sua instância de Gerenciamento de API do Azure no portal do Azure.

   

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

   

3. Clique em ... ao lado da API à qual você deseja acrescentar outra API.

4. Selecione Importar no menu suspenso.

   

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

   

Tópicos relacionados

• Limitações de importação da API
• Importar uma especificação de OpenAPI
• Importar uma API SOAP
• Importar uma API SOAP e converter em REST
• Importar uma API do Serviço de Aplicativo
• Importar uma API do Aplicativo de Contêiner
• Importar uma API WebSocket
• Importar uma API do GraphQL
• Importar um esquema do GraphQL e configurar resolvedores de campo
• Importar um Aplicativo de Funções do Azure
• Importar um Aplicativo Lógico do Azure
• Importar um serviço do Service Fabric
• Importar uma API do OpenAI do Azure
• Importar uma API de OData
• Importar metadados do SAP OData
• Importar uma API do gRPC
• Editar uma API