Importar uma API OData

2025-05-20

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

No Portal do Azure , procure e selecione Serviços de Gestão de API:
Na página de serviços de Gerenciamento de API, selecione sua instância de Gerenciamento de API:

Importar metadados OData

No menu à esquerda, selecione APIs> APIse, em seguida, selecione + Adicionar API.
Em Criar a partir da definição, selecione OData:
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 de um endpoint de metadados OData. Esse valor normalmente é a URL para a raiz do serviço, anexada com /$metadata. Como alternativa, selecione um arquivo OData XML local para importar.
2. Insira configurações adicionais para configurar sua API. Essas configurações são explicadas no tutorial Importar e publicar sua primeira API .
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.

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.

No portal, navegue até sua instância de Gerenciamento de API.
No menu à esquerda, selecione APIs e, em seguida, selecione sua API OData.
No separador Conjuntos de entidades e funções , selecione as reticências (...) junto a um conjunto de entidades ou função e, em seguida, selecione Editar.
Analise o esquema. Se quiser atualizá-lo, selecione Atualizar do ficheiro ou Atualizar esquema do endpoint.

Teste sua API OData

No menu à esquerda, selecione APIs e, em seguida, selecione sua API OData.
No separador Conjuntos de entidades e funções , selecione as reticências (...) junto a um conjunto de entidades ou função e, em seguida, selecione Testar.
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.

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.

Sugestão

No portal, configure políticas para a sua API OData no separador políticas da API.

Anexar outras APIs

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

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

Nota

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

Para acrescentar uma API a uma API existente:

Vá para sua instância de Gerenciamento de API do Azure no portal do Azure:
Selecione APIs na página Visão geral ou selecione APIs> APIs no menu à esquerda.
Selecione as reticências (...) ao lado da API à qual deseja acrescentar outra API.
Selecione Importar do menu suspenso:
Selecione um serviço a partir do qual quer importar uma API.

Partilhar via