Importar metadados OData do SAP como uma API

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

Este artigo descreve como importar um serviço OData usando sua descrição de metadados. O SAP Gateway Foundation é usado como exemplo.

Neste artigo você:

• Recuperar metadados de OData do seu serviço SAP
• Importar metadados OData para o Gerenciamento de API do Azure, diretamente ou depois de convertê-los em uma especificação do OpenAPI
• Concluir a configuração de API
• Testar a API no Portal do Azure

Pré-requisitos

• Uma instância de Gerenciamento de API. Se você não tiver uma, conclua as etapas em Criar uma instância de Gerenciamento de API usando o portal do Azure.

• Um sistema e um serviço SAP expostos como OData v2 ou v4.

• Se o back-end do SAP usar um certificado autoassinado (para teste), talvez seja necessário desabilitar a verificação da cadeia de confiança para SSL. Para fazer isso, configure um back-end em sua instância do Gerenciamento de API:

  1. Na portal do Azure, em APIs, selecione back-ends>+ Adicionar.
  2. Adicione uma URL Personalizada que aponte para o serviço de back-end do SAP.
  3. Desmarque as caixas de seleção Validar cadeia de certificados e validar o nome do certificado .

  Observação

  Em cenários de produção, use certificados adequados para verificação SSL de ponta a ponta.

Recuperar metadados de OData do seu serviço SAP

Use um dos métodos a seguir para recuperar XML de metadados de seu serviço SAP. Se você planeja converter o XML de metadados em uma especificação de OpenAPI, salve o arquivo localmente.

• Use o Cliente de Gateway do SAP (transação /IWFND/GW_CLIENT).
  ou
• Faça uma chamada HTTP direta para recuperar o XML: http://<OData server URL>:<port>/<path>/$metadata.

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 do Gerenciamento de API, selecione sua instância do Gerenciamento de API:

   

Importar uma API para o 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.
• Converta o XML de metadados em uma especificação OpenAPI.

Metadados de OData

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:

   

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.

   

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

   

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

   

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.

   

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

Especificação OpenAPI

Converter metadados OData para JSON de OpenAPI

1. Converta o XML OData em formato JSON de OpenAPI. Use uma ferramenta de código-fonte aberto OASIS para OData v2 ou OData v4, dependendo do XML de metadados.

   O exemplo a seguir converte OData v2 XML para o serviço epm_ref_apps_prod_man_srvde teste:

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Observação

   • Para testar com um único arquivo XML, você pode usar um conversor baseado na Web baseado em uma ferramenta de software livre.
   • Com a ferramenta ou o conversor baseado na Web, especificar o < endereço IP>: <porta> do seu servidor SAP OData é opcional. Como alternativa, adicione essas informações posteriormente na especificação do OpenAPI gerada ou depois de importar o arquivo para o Gerenciamento de API.

2. Salve o arquivo openapi-spec.json localmente para importá-lo para o Gerenciamento de API.

Importar especificação do OpenAPI

1. No painel de navegação esquerdo, na seção APIs , selecione APIs.

2. Em Criar uma nova definição, selecione OpenAPI:

   

3. Clique em Selecionar um arquivo e selecione o openapi-spec.json arquivo que você salvou localmente em uma etapa anterior.

4. Insira as configurações de API. Você pode definir esses valores ao importar a API ou configurá-los posteriormente acessando a guia Configurações .

   • Para o sufixo de URL da API, recomendamos usar o mesmo caminho de URL que o do serviço SAP original.

   • Para obter mais informações sobre configurações de API, confira o tutorial Importar e publicar sua primeira API.

5. Selecione Criar.

Observação

Para obter informações sobre limitações de importação de API, consulte restrições de importação de API e problemas conhecidos.

Concluir a configuração da API

Adicione as três operações a seguir à API importada:

• GET /$metadata

  Operação	Descrição	Configuração adicional para a operação
  GET /$metadata	Permite que o Gerenciamento de API acesse o ponto de extremidade $metadata, que é necessário para a integração de cliente ao servidor do OData. Essa operação necessária não está incluída na especificação OpenAPI que você gerou e importou.	Adicione uma resposta 200 OK.

  

• HEAD /

  Operação	Descrição
  HEAD /	Permite que o cliente a troque tokens de CSRF (solicitação intersite forjada) com o servidor do SAP, quando necessário. A SAP também permite a troca de token CSRF por meio do verbo GET. A troca de token CSRF não é abordada neste artigo. Veja um exemplo de snippet de política do Gerenciamento de API para a troca de token do agente.

  

• GET /

  Operação	Descrição	Configuração adicional para a operação
  GET /	Habilita a configuração de política na raiz do serviço.	Configure a seguinte política rewrite-uri de entrada para acrescentar uma barra à direita às solicitações que são encaminhadas para a raiz do serviço: <rewrite-uri template="/" copy-unmatched-params="true" /> Essa política remove a ambiguidade potencial entre solicitações com e sem barras à direita. Esses dois tipos de solicitações são tratados de forma diferente por alguns back-ends.

  

Você também precisa configurar a autenticação para seu back-end usando um método apropriado para seu ambiente. Para obter exemplos, consulte Políticas de autenticação e autorização do Gerenciamento de API.

Teste sua API

1. Navegue até sua instância de Gerenciamento de API.

2. No painel de navegação esquerdo, na seção APIs , selecione APIs.

3. Em Todas as APIs, selecione a API importada.

4. Selecione a guia Teste para acessar o console de teste.

5. Selecione uma operação, insira os valores necessários e selecione Enviar.

   Por exemplo, teste a GET /$metadata chamada para verificar a conectividade com o back-end do SAP.

6. Exiba a resposta. Para solucionar problemas, rastreie a chamada.

7. Quando terminar de testar, saia do console de teste.

Considerações sobre produção

• Veja um exemplo de cenário de ponta a ponta para integrar o Gerenciamento de API a um gateway SAP.
• Controlar 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 validar solicitação de OData. Também há snippets de política para a propagação de entidade de segurança do SAP para o SAP ECC ou S/4HANA ou o SAP SuccessFactors e a busca de um token X-CSRF.
• Para obter diretrizes sobre como implantar, gerenciar e migrar APIs em escala, consulte:
  • Implantações de API automatizadas com APIOps.
  • CI/CD para Gerenciamento de API usando modelos do Azure Resource Manager.

Conteúdo relacionado

• Limitações de importação da API
• Importar uma especificação de OpenAPI
• Importar uma API SOAP
• Importar uma API SOAP e convertê-la em REST
• Importar uma API do Serviço de Aplicativo
• Importar uma API de aplicativo de contêiner
• Importar uma API WebSocket
• Importar uma API do GraphQL
• Importar um esquema do GraphQL e configurar resolvedores de campo
• Importar uma API de aplicativo de funções
• Importar uma API de aplicativo lógico
• Importar um serviço do Service Fabric
• Importar uma API do Azure AI Foundry
• Importar uma API do OpenAI do Azure
• Importar uma API LLM
• Importar uma API de OData
• Importar metadados do SAP OData
• Importar uma API do gRPC
• Editar uma API