Importar metadados do SAP OData como uma API
APLICA-SE A: Todas as camadas de gerenciamento de API
Este artigo mostra como importar um serviço OData usando sua descrição de metadados. Neste artigo, o SAP Gateway Foundation serve como exemplo.
Neste artigo, você:
- Recuperar metadados OData do seu serviço SAP
- Importe metadados OData para o Gerenciamento de API, diretamente ou após a conversão para uma especificação OpenAPI
- Configuração completa da API
- Testar a API no Portal do Azure
Uma instância de gerenciamento de API existente. Crie um, caso ainda não o tenha feito.
Um sistema e serviço SAP expostos como OData v2 ou v4.
Se o back-end SAP usar um certificado autoassinado (para fins de teste), talvez seja necessário desativar a verificação da cadeia de confiança para SSL. Para fazer isso, configure um back-end em sua instância de Gerenciamento de API:
- No portal do Azure, em APIs, selecione Backends>+ Add.
- Adicione uma URL personalizada apontando para o serviço de back-end SAP.
- Desmarque Validar cadeia de certificados e Validar nome do certificado.
Nota
Para cenários de produção, use certificados adequados para verificação SSL de ponta a ponta.
Recupere metadados XML do seu serviço SAP, usando um dos seguintes métodos. Se você planeja converter o XML de metadados em uma especificação OpenAPI, salve o arquivo localmente.
- Use o SAP Gateway Client (transação
/IWFND/GW_CLIENT
) ou - Faça uma chamada HTTP direta para recuperar o XML:
http://<OData server URL>:<port>/<path>/$metadata
No portal do Azure, procure e selecione serviços de Gerenciamento de API.
Na página Serviços de Gerenciamento de API, selecione sua instância de Gerenciamento de API.
Escolha um dos seguintes métodos para importar sua API para o Gerenciamento de API: importe o XML de metadados como uma API OData diretamente ou converta o XML de metadados em uma especificação OpenAPI.
No menu à esquerda, selecione APIs>+ Add 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.
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.Insira as configurações restantes 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.
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> sua API OData.
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.
Analise o esquema. Se quiser atualizá-lo, selecione Atualizar do arquivo ou Atualizar esquema do ponto de extremidade.
No menu à esquerda, selecione APIs> sua API OData.
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.
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 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.
- Veja um exemplo de cenário de ponta a ponta para integrar o Gerenciamento de API com um gateway SAP.
- Controle o acesso a um back-end SAP usando políticas de gerenciamento de API. Por exemplo, se a API for importada como uma API OData, use a política de solicitação OData validada. Consulte também trechos de política para propagação de entidade SAP e busca de um token X-CSRF.
- Para obter orientação para implantar, gerenciar e migrar APIs em escala, consulte:
- Implantações automatizadas de API com APIOps
- CI/CD para Gerenciamento de API usando modelos do Azure Resource Manager.
- Limitações de importação de API
- Importar uma especificação de OpenAPI
- Importar uma API SOAP
- Importar uma API de SOAP e converter em REST
- Importar uma API do Serviço de Aplicativo
- Importar uma API de aplicativo de contêiner
- Importar uma API WebSocket
- Importar uma GraphQL API
- Importar um esquema de GraphQL e configurar resoluções de campos
- Importar uma Aplicação de Função do Azure
- Importar uma Aplicação Lógica do Azure
- Importar um serviço do Service Fabric
- Importar uma API OpenAI do Azure
- Importar uma API OData
- Importar metadados do SAP OData
- Importar uma API gRPC
- Editar uma API