Proxy de um serviço SOAP

Neste tutorial, você aprenderá como colocar um proxy de API Edge na frente de um serviço da Web baseado em SOAP.

Este tutorial ilustra como gerar uma nova API RESTful na frente do serviço baseado em SOAP. Embora não seja descrito em detalhes aqui, também é possível gerar um proxy de passagem que aceita um payload SOAP e o transmite ao serviço de back-end.

O que é necessário

• Uma conta do Apigee Edge. Se você ainda não tiver uma, inscreva-se com as instruções em Como criar uma conta do Apigee Edge.

Como criar o proxy

Aqui, você fará com que o Edge gere o proxy que ficará na frente de um serviço SOAP. Há dois tipos de proxies de API SOAP:

• O tipo de proxy**REST-SOAP-REST** gera uma nova API RESTful com uma camada de tradução para SOAP. Os clientes a chamam como fariam com outros serviços RESTful, transmitindo os parâmetros de consulta necessários pelo serviço de back-end. O Edge traduz isso no payload SOAP esperado pelo serviço.
• O tipo de proxy de passagem permite que os clientes simplesmente transmitam um payload SOAP. Essa é uma maneira de fazer com que as chamadas de serviço SOAP se beneficiem dos recursos de gerenciamento do Edge.

Como testar o proxy

Para testar o proxy que você criou, abra um prompt de comando e use o cURL. Digite o comando abaixo, em que:

• ORG é o nome da organização do Edge em que você criou o proxy.
• ENV é o ambiente em que o proxy está implantado.
• DOMAIN corresponde à instância do Edge que você está usando.

curl "https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Por exemplo, se sua organização for docfood, o ambiente for test, e você estiver usando a nuvem empresarial do Edge, execute um comando como este:

curl "https://docfood-test.apigee.net/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Se você inseriu GOOG para o parâmetro de consulta StockSymbol, vai receber o preço atual das ações da Alphabet Inc. Classe C. Exemplo:

{  
   "GetQuoteResponse":{  
      "GetQuoteResult":{  
         "StockSymbol":"GOOG",
         "LastTradeAmount":819.55,
         "LastTradeDateTime":"2017-02-13T14:33:00",
         "StockChange":5.88,
         "OpenAmount":816.0,
         "DayHigh":820.96,
         "DayLow":815.49,
         "StockVolume":785064,
         "PrevCls":813.67,
         "ChangePercent":"+0.72%",
         "FiftyTwoWeekRange":"663.28 - 841.95",
         "EarnPerShare":27.88,
         "PE":29.4,
         "CompanyName":"Alphabet Inc.",
         "QuoteError":false
      }
   }
}

Receber a especificação OpenAPI gerada automaticamente

Ao fazer o proxy de um serviço SOAP usando "REST to SOAP to REST", o Edge gera automaticamente uma especificação OpenAPI. Você pode usar a especificação OpenAPI para gerar a documentação da API.

Para receber a especificação OpenAPI, basta acessar este URL:

curl https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/openapi.json

Crédito extra: como descobrir qual recurso, verbo e parâmetros de consulta usar?

Na chamada de API de teste, você usou um recurso específico e parâmetros de consulta na chamada cURL para o serviço SOAP de back-end. Mas como você descobriria isso por conta própria?

Recurso e verbo

No assistente de proxy de API, ao criar o proxy, você viu como as operações SOAP seriam mapeadas para verbos e recursos de API. Mas, se você não anotou isso, veja como descobrir depois que o proxy for criado.

Na guia Develop do proxy de API, no painel de navegação à esquerda, você verá uma lista de fluxos em Endpoints de proxy. Clique no fluxo de seu interesse. Por exemplo, o GetQuote fluxo é um bom candidato. Em seguida, visualize o XML no painel "Code", que mostra o caminho do recurso e o verbo do fluxo no elemento <Condition>: /quote e GET.

Parâmetros de consulta

Com o fluxo GetQuote selecionado, clique na primeira política na visualização gráfica do fluxo. Ele precisa ser uma política de extração de variáveis que captura os parâmetros de consulta que precisam ser transmitidos: StockSymbol e LicenseKey. Se você fizer uma pesquisa na Web pelo serviço SOAP, ele informará o que transmitir para a LicenseKey.

Os parâmetros de consulta capturados são salvos como variáveis e usados pela próxima política para construir a mensagem SOAP.