Web サービス記述言語ツール (Wsdl.exe)

Web サービス記述言語ツールは、WSDL コントラクト ファイル、XSD スキーマ、および .discomap 探索ドキュメントから、XML Web サービスおよび XML Web サービス クライアントのコードを生成します。

wsdl [options] {URL | path}

解説

引数	説明
URL	WSDL コントラクト ファイル (.wsdl)、XSD スキーマ ファイル (.xsd)、または探索ドキュメント (.disco) への URL。.discomap 探索ドキュメントへの URL は指定できません。
Path	ローカル WSDL コントラクト ファイル (.wsdl)、XSD スキーマ ファイル (.xsd)、または探索ドキュメント (.disco または .discomap) へのパス。 メモ : Wsdl.exe は、ローカル ファイルが指定されている場合、ネットワークからインクルードやインポートを取得しません。Wsdl.exe でローカル ファイルの処理中にネットワーク リソースの取得を有効にするには、ローカル ファイルへの URL を渡します。たとえば、次のファイルでは必要なリソースの取得にネットワークを使用します。 wsdl File:///E:/Customers/WSDLS/Accounts.wsdl /out:proxy.cs

.wsdl ファイルは、Web サービス記述言語 (WSDL: Web Service Description Language) という XML 文法で記述された XML ドキュメントです。このファイルは、XML Web サービスの動作を定義し、サービスとの対話方法をクライアントに命令します。

Web サービス検出ツール (Disco.exe) を使用して、XML Web サービスの探索ドキュメントを取得できます。このツールで生成された .discomap、.disco、.wsdl、.xsd の各ファイルは、Wsdl.exe への入力として使用できます。

Wsdl.exe を使用してプロキシ クラスを作成すると、指定したプログラミング言語で 1 つのソース ファイルが作成されます。プロキシ クラスのソース コードを生成するプロセスでは、このツールは、サービス記述で指定されたオブジェクトに使用する最適な型を決定します。場合によっては、共通する必要最低限の機能を提供するアプローチを使用して、オブジェクトを型にキャストします。結果として、そのプロキシ クラスの生成された型が開発者の意図するものと異なることがあります。たとえば、Wsdl.exe がサービスの説明で ArrayList 型を検出した場合は、生成するプロキシ クラス内に Object Array を作成します。オブジェクト型が正しくキャストされるようにするには、生成されたプロキシ クラスが含まれているファイルを開き、不適切なオブジェクト型を正しいオブジェクト型に変更します。

• /parameters オプションには、ほとんどのコマンド プロンプト オプションに対応する要素を含むファイルを指定します。一部のコマンド プロンプト オプションは、/parameters のファイル形式だけで使用できます。

/parameters オプションが受け入れる XML ファイル形式には、<wsdlParameters xmlns="https://microsoft.com/webReference/"> 要素で囲まれた一連の要素があります。コマンド プロンプト値を指定し、異なるオプションまたは値を含む /parameters ファイルを使用すると、コマンド プロンプトで指定した値が使用されます。<wsdlParameters xmlns="https://microsoft.com/webReference/"> 要素は、<nologo> 要素、<parsableerrors> 要素、および <sharetypes> 要素を含む必要があります。

いくつかのオプションは <verbose> 要素を必ず含む <webReferenceOptions> 要素の子要素として渡されます。その他の <webReferenceOptions> 要素の子要素は次のとおりです。

• <style> - "client"、"server"、または "serverInterface" を含みます。

• <schemaImporterExtension> - 任意の数の <type> 要素を含みます。

• <codeGenerationOptions> - スペースで区切られた次の文字列を受け取ることができます。

• "properties"

• "newAsync"

• "oldAsync"

• "order"

• "enableDataBinding"

/parameters オプションの例については、次の「例」のセクションを参照してください。

例

次のコマンドは、XML Web サービスのために C# 言語でクライアント プロキシ クラスを作成します。

wsdl http://hostServer/WebserviceRoot/WebServiceName.asmx?WSDL

指定した URL にある XML Web サービスの C# 言語におけるクライアント プロキシ クラスを作成するコマンドを次に示します。このツールは、クライアント プロキシ クラスを myProxyClass.cs ファイルに保存します。

wsdl /out:myProxyClass.cs http://hostServer/WebserviceRoot/WebServiceName.asmx?WSDL

指定した URL にある XML Web サービスの Microsoft Visual Basic 言語におけるクライアント プロキシ クラスを作成するコマンドを次に示します。このツールは、クライアント プロキシ クラスを myProxyClass.vb ファイルに保存します。

wsdl /language:VB /out:myProxyClass.vb http://hostServer/WebserviceRoot/WebServiceName.asmx?WSDL

コマンド プロンプトで URL 引数と組み合わせて使用できる必須の要素だけを含む基本的な /parameters WSDL ファイルのコード例を次に示します。

<wsdlParameters xmlns="https://microsoft.com/webReference/">
  <nologo>true</nologo>
  <parsableerrors>true</parsableerrors>
  <sharetypes>true</sharetypes>
</wsdlParameters>

WSDL ドキュメントは、次のコード例のように、<documents> 要素を使用して /parameters WSDL ファイルに追加されます。<documents> 要素では、任意の数の <document> 要素を使用できます。

<wsdlParameters xmlns="https://microsoft.com/webReference/">
  <nologo>true</nologo>
  <parsableerrors>true</parsableerrors>
  <sharetypes>true</sharetypes>
  <documents>
    <document>https://www.contoso.com/service.asmx?WSDL</document>
  </documents>
</wsdlParameters>

次の /parameters WSDL ファイルは、<webReferenceOptions> 要素内の <codeGenerationOptions> 要素と <style> 要素の使い方を示します。この場合、このファイルはプロキシ コードで新しいスタイルのデータ バインディングを有効にし、スキーマ インポータの拡張機能を指定し、詳細情報は出力せず、Wsdl.exe はクライアント プロキシを作成するように指定します。

<wsdlParameters xmlns="https://microsoft.com/webReference/">
  <nologo>true</nologo>
  <parsableerrors>true</parsableerrors>
  <sharetypes>true</sharetypes>
  <documents>
    <document>https://www.contoso.com/service.asmx?WSDL</document>
  </documents>
  <webReferenceOptions>
    <verbose>false</verbose>
    <codeGenerationOptions>properties newAsync enableDataBinding</codeGenerationOptions>
    <schemaImporterExtension>
      <type>MyNamespace.MyCustomImporterExtension,ExtensionLibrary</type>
    </schemaImporterExtensions>
    <style>client</style>
  </webReferenceOptions>
</wsdlParameters>

関連項目

参照

Web サービス検出ツール (Disco.exe)

概念

XML Web サービス プロキシの作成
XML Web サービスの説明
XML Web サービスの概要

その他の技術情報

.NET Framework Tools
SDK Command Prompt

Copyright © 2007 by Microsoft Corporation.All rights reserved.