Proxy de um serviço SOAP

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

Neste tutorial, ilustramos como gerar uma nova API RESTful na frente do serviço baseado em SOAP. Embora não esteja descrito em detalhes aqui, também é possível gerar um proxy de passagem que aceite um payload de SSO e o passe para o serviço de back-end.

Pré-requisitos

• 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, o Edge gera o proxy que ficará na frente de um serviço Soap. Há dois tipos de proxies da API NoSQL:

• O tipo de proxy REST-SOAP-REST gera uma nova API RESTful com uma camada de conversão para a solução. Os clientes a chamam como fariam com outros serviços RESTful, passando os parâmetros de consulta necessários para o serviço de back-end. O Edge converte isso no payload de SSO esperado pelo serviço.
• O tipo de proxy de proxy de passagem permite que os clientes simplesmente transmitam um payload de SSO. Essa é uma forma de aproveitar os recursos de gerenciamento do Edge para as chamadas de serviço DAO.

Como testar o proxy

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

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

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

Por exemplo, se a 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, verá 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
      }
   }
}

Acessar a especificação OpenAPI gerada automaticamente

Quando você faz o proxy de um serviço DAO usando "REST para DAO para REST", o Edge gera automaticamente uma especificação OpenAPI. Use a especificação OpenAPI para gerar a documentação referente à API.

Para conseguir a especificação OpenAPI, acesse este URL:

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

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

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

Recurso e verbo

Ao criar o proxy, no assistente de proxy de API, você viu como as operações de SSO são mapeadas para verbos e recursos da API. Mas, se não as anotou, veja como descobriria depois da criação do proxy.

Na guia Desenvolver do proxy de API, no painel esquerdo do Navigator, você verá uma lista de fluxos sob os endpoints do proxy. Clique no fluxo em que você tem interesse. Por exemplo, o fluxo GetQuote é um bom candidato. Em seguida, visualize o XML no painel Code, que mostra o caminho do recurso e o verbo para o fluxo no elemento <Condition>: /quote e GET.

Parâmetros de consulta

Com o fluxo GetQuote selecionado, clique na primeira política na visualização de fluxo gráfico. Ela precisa ser uma política de extração de variáveis que capture os parâmetros de consulta que precisam ser transmitidos: StockSymbol e LicenseKey. Se você fizer uma pesquisa na Web pelo serviço NoSQL, 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 criar a mensagem de SSO.