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 (Open Data Protocol) para o Gerenciamento de API do Azure usando metadados OData. O exemplo a seguir usa o SAP Gateway Foundation.

Neste artigo, você aprenderá como:

  • Recuperar metadados de OData do seu serviço SAP
  • Importar metadados OData para 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

  • Crie uma instância de Gerenciamento de API.

  • 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. No portal do Azure, em APIs, selecione Back-ends>+ Criar novo back-end.
    2. Adicione uma URL Personalizada que aponte para o serviço de back-end do SAP.
    3. Expanda a seção Avançado e 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.

    Dica

    Para o escopo completo do recurso do Gerenciamento de API, converta a API do SAP OData na especificação OpenAPI antes de registrar.

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).
  • Faça uma chamada HTTP direta para recuperar o XML: http://<OData server URL>:<port>/<path>/$metadata.
  • Use o SAP Business Accelerator Hub, se aplicável.

Navegar até a instância de Gerenciamento de API

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

    Captura de tela que mostra os serviços de Gerenciamento de API nos resultados da pesquisa.

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

    Captura de tela que mostra uma instância de Gerenciamento de API na página Serviços de 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:

  • Converta o XML de metadados em uma especificação OpenAPI (recomendado).
  • Importe o XML de metadados como uma API OData diretamente.

Converter metadados OData para JSON de OpenAPI

  1. Use o conversor Microsoft construído em cima da ferramenta de código aberto OASIS.

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

    oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json

    Observação

    Para testar com um único arquivo XML, você pode usar a experiência baseada na Web.

  2. Salve o arquivo openapi-spec.json localmente para importação para o Gerenciamento de API.

Importar especificação do OpenAPI

  1. No menu da barra lateral, na seção APIs , selecione APIs.

  2. Em Criar a partir da definição, selecione o bloco OpenAPI :

    Captura de tela que mostra o bloco OpenAPI.

  3. Escolha Selecionar um arquivo e selecione o arquivo openapi-spec.json 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.

Você também precisa configurar a autenticação para seu back-end usando um método apropriado para seu ambiente. Para obter exemplos, consulte Autenticação e autorização.

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.

Teste sua API

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

  2. No menu da barra lateral, selecione APIs>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

Conteúdo relacionado

  • Last updated on