Import WSDL

Internamente, o fluxo de execução de uma requisição a um serviço WSDL ocorre da seguinte forma:

A imagem acima representa o que acontece no gateway durante uma chamada. Primeiramente, os dados no corpo da requisição são transformados de JSON para XML. Em seguida, o interceptor XSL Transformation realiza a transformação via mapeamento dos dados XML do corpo com o XSL presente dentro do próprio interceptor para a criação de um envelope SOAP válido para ser usado posteriormente em uma chamada HTTP POST comum, como demonstrado na imagem abaixo.

Depois que o servidor SOAP retorna a resposta da execução da chamada POST, a resposta desta chamada retorna para o Gateway para sofrer outra transformação. O envelope SOAP com o resultado da operação passa novamente por um interceptor XSL Transformation, que tem a função de transformar o conteúdo do envelope SOAP em um JSON usando o mapeamento presente em um documento XSL salvo dentro do interceptor. Terminada essa transformação, o Gateway retorna um corpo JSON para o cliente.

O cadastro de uma API para uso do WSDL é muito semelhante ao cadastro de uma API comum. Para começar, clique no botão Import WSDL dentro da seção Resources da API (seja quando estiver criando uma nova API ou editando uma já existente).

Uma janela modal será aberta, por meio da qual você poderá importar o arquivo WSDL de duas formas: via inserção da URL onde o WSDL está hospedado,

ou via upload do arquivo com extensão .wsdl ou .xml:

Depois da escolha do método de upload do seu arquivo WSDL, clique no botão Validate. O conteúdo do arquivo só será mandada para o servidor se os dados do arquivo ou URL inseridos estiverem corretos.

O botão Validate irá retornar mensagens de erro caso o arquivo ou URL carregados sejam inválidos. No caso de falha na leitura do WSDL de uma URL, a seguinte mensagem será exibida:

Nesse caso, a URL foi passada com formato correto, mas a leitura do WSDL presente nessa URL apresentou falha, pois o arquivo tem algum conteúdo inválido em sua integridade.

Por sua vez, se o formato de URL for inválido (só são aceitas URLs iniciadas por http(s)://), a seguinte mensagem será exibida:

Caso o formato não seja aceito, o botão Validade não será habilitado.

Se a URL estiver correta e o arquivo do WSDL tiver conteúdo válido, o botão de upload será habilitado e, por meio dele, será possível enviar os dados para o servidor.

Se a importação do WSDL ocorrer por meio de arquivos, a validação é apresentada da seguinte maneira: se você tentar validar um arquivo de extensão inválida, a mensagem "Invalid WSDL Format" aparecerá, indicando que o formato do arquivo carregado não é aceito pela aplicação. Somente arquivos nos formatos .wsdl e .xml são aceitos.

Se o arquivo tiver formato válido mas conteúdo com problemas, a mensagem de erro de validação será a seguinte:

No caso acima, a validação do arquivo acusa que o conteúdo do WSDL é inválido, causando algum tipo de erro no envio do arquivo.

Se o arquivo escolhido tiver a extensão correta e um conteúdo íntegro, o botão Validade retornará uma mensagem de sucesso e o botão Upload será habilitado.

Após o upload, o usuário será direcionado para a tela de listagem dos serviços e operações presentes no WSDL. No exemplo mostrado abaixo, usamos o WSDL do web service dos Correios para rastreamento de objetos: https://github.com/wmixvideo/correios/blob/master/src/main/java/br/com/correios/webservice/rastro/Rastro.wsdl.

A tela apresenta cada serviço descrito no WSDL (no caso, o ServicePortBinding) com o seu conjunto de operações (buscaEventosLista e buscaEventos).

Ao expandir um serviço do WSDL, temos a lista das seguintes informações:

Para transformar cada uma das operações em recursos da sua API, selecione os itens desejados, defina o método HTTP que cada um irá representar e altere o nome de cada recurso, caso necessário.

Depois de completar tudo, clique no botão Save and return to Resources. Você será redirecionado para a tela de listagem de recursos com os itens já transformados:

Após essa etapa, você pode continuar com o fluxo normal de criação da API.

Caso seja necessário incluir ou editar algum recurso criado a partir de um WSDL, o arquivo deve ser importado novamente, e todos os recursos já cadastrados que fizerem parte daquele WSDL virão marcados na exibição das operações.

Depois de realizar a importação de um arquivo WSDL e estabelecer os recursos relacionados, haverá a inclusão de seis interceptores que irão auxiliar na chamada e execução de cada operação gerada a partir do WSDL. Acesse a documentação de Interceptors para saber mais. Eles são:

A imagem acima mostra a aplicação dos interceptors no recurso /buscaeventos. Esses interceptores serão usados pelo gateway para execução das chamadas a essa ou outras operações criadas.