SOAPのWSDLについて調べてみた

今更ですがSOAPを利用したWEB APIを触ることになったのですが、SOAPの仕様がわけわからん過ぎて困ったので基礎に立ち返って調べてみました。

SOAPにはWSDLというファイルがあって、事前にAPI定義をXMLで公開するみたいです。まずは「そもそもWSDLには何が記述してある？」かを追って見ることに。

WSDLとは

そのWebサービスはどこにあるのか

そのWebサービスは、どんなフォーマットのメッセージを使って利用するのか

そのWebサービスは、どんな通信プロトコルを使ってメッセージをやり取りするのか

引用元：http://www.atmarkit.co.jp/ait/articles/0303/18/news003.html

SOAPとは、元はSimple Object Access Protocolの頭文字だったけど、もはやシンプルでもなんでもないものに複雑怪奇なものになっているとか。

WSDLのメリットは下記のようなのがあるとのこと。

Webサービスのために、そのインターフェイスを記述したWSDL文書が用意されていることは、Webサービスの利用者に大きな利得となる。開発ツールにWSDL文書を読み込ませることによって、Webサービスを呼び出すモジュールのコードを自動生成できるようになるからだ。

ふむふむ。

どの旅行代理店でもほぼ共通した内容だ。このような場合、業界団体では、Webサービスとして公開するホテル予約サービスシステムのインターフェイスを標準化することが考えられる。業界団体は、標準化されたインターフェイスの仕様を記述したWSDL文書を作成し、それを一般に公開することになるだろう。

昨今ではどこのWEBサービスでもSOAPを使っているところはほとんどないので、目論見通りにはならなかったみたいですね。

（1）WSDL文書は抽象的な定義と具体的な定義の、2つのステップで構成されている

だからこんなに定義の重複っぽいのが目につくのか。

この辺りを参考にさせていただきました。

http://www.atmarkit.co.jp/ait/articles/0304/24/news002.html

サンプルWSDL

一番シンプルなwsdlをめざして作ったけど既に謎だらけ。一つ一つ調べてみてコメントいれました。

<?xml version="1.0" encoding="UTF-8"?>

<wsdl:definitions

<!--

対象名前空間URIの定義。よくわからんけど任意の値で良いみたい。

多くのサンプルではそのWEBサービスのURIを記載していた。

-->

targetNamespace="http://example.com/Service01"

<!--

わからんけど親がtargetNamespaceなのに対して、子がxmlns:implみたいな印象を受けた。

任意の値でいいっぽい。

-->

xmlns:impl="http://example.com/Service01"

<!--

xmlnsは、各々で定義されてるxmlマークアップを使うということ。おまじない程度の理解で良さそう。

-->

xmlns:apachesoap="http://xml.apache.org/xml-soap"

xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"

xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

xmlns="http://schemas.xmlsoap.org/wsdl/">

<!--

WEBサービスで使用されるmessage(インタフェース？)の抽象的定義。

-->

<wsdl:message name="addHexString">

<wsdl:part name="text" type="xsd:string" />

<wsdl:part name="num" type="xsd:int" />

</wsdl:message>

<wsdl:message name="addHexStringResponse">

<wsdl:part name="addHexStringReturn" type="xsd:string" />

</wsdl:message>

<wsdl:portType name="Service01">

<!--

メソッドのインターフェース定義に対応する。

nameがメソッド名、parameterOrderが引数の順序。

-->

<wsdl:operation name="addHexString" parameterOrder="text num">

<!--

input/output/faultという種類があるらしい。

それぞれのメッセージのフォーマットが上で定義したmessageに対応する。

-->

<wsdl:input name="addHexString"

message="impl:addHexString" />

<wsdl:output name="addHexStringResponse"

message="impl:addHexStringResponse" />

</wsdl:operation>

</wsdl:portType>

<!--

抽象的な操作やメッセージを具体的なプロトコルにやメッセージにバインディングする。

nameは、serviceで参照するための名前。

typeはどのportTypeに対応するかを指定(上で定義したportType)。

-->

<wsdl:binding

name="Service01SoapBinding" type="impl:Service01">

<!--

SOAPプロトコルにバインディング、RPC志向であることを明示してる。

文書指向というのもあるらしい

-->

<wsdlsoap:binding style="rpc"

transport="http://schemas.xmlsoap.org/soap/http" />

<wsdl:operation name="addHexString">

<wsdlsoap:operation soapAction=""/>

<wsdl:input name="addHexString">

<wsdlsoap:body use="encoded"

encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />

</wsdl:input>

<wsdl:output name="addHexStringResponse">

<wsdlsoap:body use="encoded"

encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />

</wsdl:output>

</wsdl:operation>

</wsdl:binding>

<wsdl:service name="Service01">

<!--

nameはportTypeで定義した名前。

bindingは対応するbindingの名前。

-->

<wsdl:port name="Service01"

binding="impl:Service01SoapBinding">

<wsdlsoap:address

location="http://mac-book-air.local:8088/mockService01SoapBinding"/>

</wsdl:port>

</wsdl:service>

</wsdl:definitions>

率直な感想。
wsdlsoap:addressのlocationだけあればあとの定義いらなくね？と思った。

この記事を書いた人
最新の記事

原田敦

日本CAWのエンジニア。もふもふ部の部長。得意分野はRuby on Railsを使った小規模WEBアプリケーションを高速で開発すること。週末の楽しみは一人お菓子パーティー。三度の飯より小動物をもふもふするのが好きです。

WSDLとは

サンプルWSDL

原田 敦

最新記事 by 原田 敦 (全て見る)

原田敦

最新記事 by 原田敦 (全て見る)