使用 WSDL 2.0 描述 REST Web 服务

最新推荐文章于 2023-12-19 23:53:29 发布
最新推荐文章于 2023-12-19 23:53:29 发布
阅读量560 收藏 3
点赞数
文章标签： rest web documentation binding interface eclipse

 

Web 服务的核心是定义一种使用网络和 XML 来进行计算机到计算机交互的机制。Web 服务的一个重要组件是使用 Web 服务描述语言（Web Services Description Language，WSDL）的正式描述。一直以来没有一种正式的语言来描述 REpresentational State Transfer (REST) Web 服务，直到现在出现了 WSDL 2.0。本文向您介绍 REST 和 WSDL 2.0，并指导您创建 REST Web 服务的 WSDL 2.0 描述。

引言

Web 服务 这个术语通常与使用 SOAP 和 WS* 标准（例如 WS-Addressing 和 WS-Security）的基于操作的服务相关联。REST Web 服务 这个术语一般是指使用 HTTP 和 XML 的基于资源的 Web 服务体系结构。其中每种体系结构的 Web 服务风格各有其影响力，但是直到最近，WSDL 不再同等地支持这两种风格。WSDL 1.1 HTTP 绑定不足以描述使用 HTTP 和 XML 的通信，因此没有办法使用 WSDL 来正式地描述 REST Web 服务。WSDL 2.0 在设计时考虑到了 REST Web 服务，将 WSDL 2.0 作为 World Wide Web Consortium (W3C) 建议标准来发布意味着现在有了用于描述 REST Web 服务的语言。

REST

REST 是一种体系结构风格，它将 Web 服务视为以资源为中心的应用程序。实际上，这意味着 RESTful 应用程序中的每个 URL 表示一个资源。URL 还易于理解和记忆。例如，某个书店可能为其销售的图书列表定义 URL http://www.bookstore.com/books/，并对 ISBN 为 0321396855 的特定图书的相关详细信息定义了 URL http://www.bookstore.com/books/0321396855/。这与以操作为中心的应用程序形成鲜明对比，后者通常具有很长的加密 URL，用于描述要执行的特定操作，例如 http://www.bookstore.com/action/query?t=b&id=11117645532&qp=0321396855。查询参数用于筛选结果。使用同样的书店示例，指定主题参数可以将图书列表限制到关于某个特定主题的图书。例如，URL http://www.bookstore.com/books/?subject=computers/eclipse 将返回关于 Eclipse 平台的图书列表。

Roy Fielding 博士在他的博士论文中提出了术语 REST，他在其中提到了“作为应用程序状态引擎的超媒体”。这意味着资源预期将包含超链接。这些超链接是用以进行转换的方法，该转换或者改变资源状态，或者转移到另一个资源。虽然超链接在由人类使用的 (X)HTML 应用程序中司空见惯，但它们通常不出现在由计算机使用的 XML 中。与 (X)HTML 一样，REST Web 服务在 XML 中利用了超链接。

传统 Web 应用程序使用 HTTP GET 或 POST 操作来访问资源。相反，RESTful 应用程序全面使用了 HTTP 谓词（POST、GET、PUT 和 DELETE），按照创建、读取、更新和删除 (CRUD) 模式来访问资源。

REST 应用程序存在一个更重要的组件：RESTful 应用程序应该是无状态的。这意味着在 REST 应用程序中，服务器上没有存储任何会话状态。满足请求所需要的所有信息都携带在请求消息本身之中。因此在服务显式地允许的情况下，客户端可以缓存资源的表示形式，从而显著改进应用程序的性能。要了解有关 REST 的更多信息，请参阅本文结尾的参考资料部分。

返回其他内容类型

Web 服务一般将数据作为 XML 返回，但是存在其他对服务使用者有用的内容类型。例如，Asynchronous JavaScript + XML (Ajax) 应用程序一般最好接收 JavaScript Object Notation (JSON) 数据，而人类使用者可能希望将数据作为可在浏览器中呈现的 HTML 来进行接收。

在 HTTP 世界中，数据格式的选择称为内容类型协商。在内容类型协商中，客户端指定首选的内容类型和可接受的内容类型，然后服务使用最适当的内容类型来响应。这意味着客户端 A 可以向 Web 服务请求 XML 格式的数据，客户端 B 可以请求 JSON 或其他某种类型的数据。

为了赋予客户端请求某种内容类型的能力，可以相应地构造服务，使其利用内置的 HTTP Content-Type 标头： Content-Type: text/html。

对于不理解 Content-Type 标头的应用程序，一种备选方法是在 URL 上指定诸如 cType 等参数，例如在 http://www.bookstore.com/books/?cType=application/xml 中那样。

WSDL 和 REST

WSDL 描述包含 Web 服务的所有详细信息，包括：

  • 服务的 URL。
  • 服务所理解的通信机制。
  • 服务所能执行的操作。
  • 服务消息的结构。

客户端可以使用这些详细信息来与服务进行交互。

毫无疑问，REST Web 服务到目前为止还没有利用 WSDL 1.1 HTTP 绑定的一个重要原因是由于 WSDL 1.1 HTTP 绑定不足以描述 REST Web 服务。

WSDL 2.0 于 2007 年 6 月被宣布为 W3C 建议标准。创建 WSDL 的这第二个版本是为了解决 WSDL 1.1 存在的问题，Web 服务互操作性（Web Services Interoperability，WS-I）组织已确定了其中的许多问题。此外，WSDL 2.0 还具有对 HTTP 绑定的良好支持。

WSDL 是一种正式地描述 Web 服务的 XML 语言。可以将 Web 服务的 WSDL 描述看作是其与客户端之间签署的的 API 契约。WSDL 描述指定 Web 服务的地址、允许的通信机制、接口和消息类型。简而言之，WSDL 描述为客户端提供了使用 Web 服务所需要的所有信息。

WSDL 的可用性不只是用作 API 契约。作为正式的定义，WSDL 可由 Web 服务工具用于执行操作，例如：

  • 采用各种语言生成客户端和服务存根。
  • 发布 Web 服务。
  • 动态测试 Web 服务。

绝大多数 Web 服务工具都包括对 WSDL 1.1 的支持，并且对 WSDL 2.0 的支持也正在增加。Apache Web 服务项目包含两个目前支持 WSDL 2.0 的子项目。Woden 是一个基于 Java™ 的 WSDL 2.0 验证分析器。该项目还包含 XSL Transformation (XSLT) WSDL 2.0 优质打印机，用于提供更加可读的 WSDL 文档形式。同样来自于 Apache 的 Axis2 是一个流行的 Web 服务运行时引擎，能够在 WSDL 2.0 文档的基础上生成 Java 客户端和服务器存根。





回页首

使用 WSDL 2.0 描述 REST Web 服务

本文的其余部分将指导您完成所需的步骤，以使用下面的简单示例场景来为一个 REST Web 服务创建 WSDL 2.0 描述。

您将运作一家具有创造性 URL 的书店：http://www.bookstore.com。您先前已经创建了两个 REST Web 服务：

  • 图书列表服务 检索您的书店中销售的图书的列表。
  • 图书详细信息服务检索有关某一本特定图书的详细信息。

信息在 XML 文档中返回。请考虑一下有关那些服务的详细信息：

图书列表服务的 URL 为 http://www.bookstore.com/books/。因为您是一家历史悠久的图书零售商，所以您销售的图书的列表相当大。因此您提供了以下查询参数列表，客户可以使用这些参数来筛选结果：

  • Author
  • Language
  • Publisher
  • Subject
  • Title

例如，URL http://www.bookstore.com/books/?subject=computers/eclipse 返回有关 Eclipse 的计算机图书的列表，如清单 1 所示。


清单 1. 来自图书列表服务的响应

                
<booklist:bookList xmlns:booklist="http://www.bookstore.org/booklist/xsd"
   xmlns:book="http://www.bookstore.org/book/xsd"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://www.bookstore.org/booklist/xsd booklist.xsd 
                       http://www.bookstore.org/book/xsd book.xsd">

  <booklist:book url="http://www.bookstore.com/books/0321442598"
     title="BIRT: A Field Guide to Reporting"/>
  <booklist:book url="http://www.bookstore.com/books/0321205758"
     title="Contributing to Eclipse: Principles, Patterns, and Plug-Ins"/>
  <booklist:book url="http://www.bookstore.com/books/0321245873"
     title="Eclipse AspectJ: Aspect-Oriented Programming with AspectJ and the..."/>
  <booklist:book url="http://www.bookstore.com/books/0321288157"
     title="Eclipse Distilled"/>
  <booklist:book url="http://www.bookstore.com/books/0131425420"
     title="Eclipse Modeling Framework"/>
  <booklist:book url="http://www.bookstore.com/books/0321334612"
     title="Eclipse Rich Client Platform: Designing, Coding, and Packaging Java..."/>
  <booklist:book url="http://www.bookstore.com/books/0321396855"
     title="Eclipse Web Tools Platform: Developing Java Web Applications"/>
  <booklist:book url="http://www.bookstore.com/books/032142672X"
     title="Eclipse: Building Commercial-Quality Plug-Ins (2nd Edition)"/>
  <booklist:book url="http://www.bookstore.com/books/0321443853"
     title="Integrating and Extending BIRT"/>
  <booklist:book url="http://www.bookstore.com/books/0321268385"
     title="Official Eclipse 3.0 FAQs"/>
  <booklist:book url="http://www.bookstore.com/books/0321256638"
     title="Official Eclipse 3.0 FAQs"/>
</booklist:bookList>

图书详细信息服务的 URL 为 http://www.bookstore.com/books/ISBN_NUMBER，其中 ISBN_NUMBER 应该替换为特定图书的 ISBN。例如，URL http://www.bookstore.com/books/0321396855 将返回我的图书 Eclipse Web Tools Platform 的详细信息，如清单 2 所示（请参阅参考资料以获得指向该图书网站的链接）。


清单 2. 来自图书详细信息服务的响应

                
<book:book xmlns:book="http://www.bookstore.org/book/xsd" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:schemaLocation="http://www.bookstore.org/book/xsd book.xsd">
  <book:title>Eclipse Web Tools Platform: Developing Java Web Applications</book:title>
  <book:author>
    <book:firstName>Naci</book:firstName>
    <book:lastName>Dai</book:lastName>
  </book:author>
  <book:author>
    <book:firstName>Lawrence</book:firstName>
    <book:lastName>Mandel</book:lastName>
  </book:author>
  <book:author>
    <book:firstName>Arthur</book:firstName>
    <book:lastName>Ryman</book:lastName>
  </book:author>
  <book:overview>
Discover Eclipse Web Tools Platform (WTP), the new end-to-end toolset for Java-based
Web development. The WTP seamlessly integrates all of the tools today's Java Web 
developer needs. Eclipse WTP is both an unprecedented open source resource for 
working developers and a powerful foundation for state-of-the-art commercial products.
This book offers in-depth descriptions of every tool included in WTP, introducing powerful
capabilities never before available in Eclipse. The authors cover the entire 
Web-development process -- from defining Web application architectures and 
development processes through testing and beyond. And if you're seeking to extend WTP,
this book provides an introduction to the platform's rich APIs. The book also
  </book:overview>
  <book:pages>752</book:pages>
  <book:publisher>Addison-Wesley Professional</book:publisher>
  <book:language>English</book:language>
  <book:isbn-10>0321396855</book:isbn-10>
  <book:isbn-13>978-0321396853</book:isbn-13>
  <book:price>54.99</book:price>
</book:book>

在下面的几个部分中，您将了解如何使用上面列出的详细信息来创建图书列表服务的 WSDL 2.0 描述。图书详细信息服务虽然在该场景中有用，但其 WSDL 描述并没有结构上的不同，因此本文将不介绍该服务。然而，本文结尾的下载部分提供了图书列表和图书详细信息服务的 WSDL 2.0 描述以及清单 1 和清单 2 中的相同文档。

在开始图书列表服务的 WSDL 描述之前，让我们首先看一下 WSDL 2.0 基础。

WSDL 2.0 基础

WSDL 2.0 是核心命名空间为 http://www.w3.org/ns/wsdl 的 XML 语言。WSDL 2.0 文档的根元素是 description 元素。description 具有四个子元素，它们共同封装了关于某个 Web 服务的所有详细信息。

  • types
  • interface
  • binding
  • service

WSDL 2.0 文档的框架如清单 3 所示。


清单 3. WSDL 2.0 文档框架

                
<wsdl:description xmlns:wsdl="http://www.w3.org/ns/wsdl">
  <wsdl:types/>
  <wsdl:interface/>
  <wsdl:binding/>
  <wsdl:service/>
</wsdl:description>

WSDL 2.0 中有什么变化？

WSDL 2.0 文档的结构与 WSDL 1.1 具有某些相当显著的区别。下面的区别列表无论如何也不算完整，但是的确包含了一些值得注意的区别：

  • 根元素已从 definitions 更改为 description。
  • portType 元素已被替换为 interface 元素，以更好地反映其用途。
  • message 元素不再作为一个全局元素而存在。消息描述现在封装在 interface 元素中。
  • 绑定现在是可重用的。不需要将其与某个特定的接口相关联。关联可以在服务声明中建立。
  • 在 WSDL 1.1 中能够以多种方式导入的 XML 模式，现在使用 types 元素的直接子元素 xsd:import 来进行导入。

types 元素包含了描述 Web 服务消息的所有 XML 模式元素和类型定义。WSDL 2.0 对其他类型系统的使用保持开放，但实际上仅与 XML 模式一起使用。

interface 元素定义 Web 服务操作，包括特定的输入、输出和所传递的错误消息，以及传递那些错误消息的顺序。

binding 元素定义客户端如何与 Web 服务通信。在 REST Web 服务的情况下，一个绑定指定客户端可以使用 HTTP 进行通信。

service 元素将 Web 服务的地址与特定的接口和绑定相关联。

WSDL 2.0 定义了另外两个关于 REST Web 服务的相关命名空间：

  • HTTP 命名空间 http://www.w3.org/ns/wsdl/http，其中包括 HTTP 绑定元素
  • WSDL 扩展命名空间 http://www.w3.org/ns/wsdl-extensions，其中包括三个属性的定义：两个用于将 XML 文档中的超链接与 Web 服务描述相关联，第三个用于安全地描述 Web 服务操作

下面几个部分将更详细地介绍本部分中讨论的所有 WSDL 元素。

处理图书列表服务

提醒一下，图书列表服务的 URL 为 http://www.bookstore.com/books/。为了处理该服务，您将使用 WSDL service 元素，此元素至少需要一个 endpoint 子元素。endpoint 元素的 address 属性用于指定该服务的 URL，如清单 4 所示。endpoint 元素还用于将某个绑定与具有 binding 属性的服务关联起来。service 元素反过来又将某个接口与具有 interface 属性的服务关联起来。您将在以下几个部分中创建接口和绑定，因此现在可以将这些属性值保留空白。

图书列表服务的 WSDL 2.0 文档还需要一个目标命名空间，因此定义命名空间 http://www.bookstore.org/booklist/wsdl。


清单 4. 图书列表服务定义

                
<wsdl:description xmlns:wsdl="http://www.w3.org/ns/wsdl"
   targetNamespace="http://www.bookstore.org/booklist/wsdl"
   xmlns:tns="http://www.bookstore.org/booklist/wsdl">

  <wsdl:service name="BookList" interface="">
    <wsdl:documentation>
       The bookstore's book list service.
    </wsdl:documentation>
    <wsdl:endpoint name="BookListHTTPEndpoint"
       binding=""
       address="http://www.bookstore.com/books/">
    </wsdl:endpoint>
  </wsdl:service>
</wsdl:description>

与图书列表服务进行 HTTP 通信

图书列表服务的绑定定义需要指定该服务使用 HTTP 来进行通信。为此，可以为 binding 元素的 type 属性指定值 http://www.w3.org/ns/wsdl/http。

该绑定还可以选择引用某个接口。将 interface 属性保留空白；您将在下一个部分中创建该属性。如果某个接口与该绑定相关联，binding 可以选择声明一个子 operation 元素，用于镜像接口的 operation 元素。您需要创建一个存根 operation 元素，并在创建接口以后填充此引用。

存在四个 HTTP 通信谓词：

  • GET
  • PUT
  • POST
  • DELETE

图书列表服务是读取请求，因此使用 HTTP GET 进行通信。使用 WSDL 2.0 HTTP 命名空间中的 HTTP method 属性，在 operation 元素上设置 GET 谓词。要使用此属性，您首先需要在 Description 元素上声明命名空间 http://www.w3.org/ns/wsdl/http。

清单 5 显示了图书列表服务的 HTTP 绑定声明。现在既然已经声明了绑定，您可以将 endpoint 元素的绑定引用更新为引用 tns:BookListHTTPBinding。


清单 5. 图书列表绑定定义

                
<wsdl:description xmlns:wsdl="http://www.w3.org/ns/wsdl"
   targetNamespace="http://www.bookstore.org/booklist/wsdl"
   xmlns:tns="http://www.bookstore.org/booklist/wsdl"
   xmlns:whttp="http://www.w3.org/ns/wsdl/http">

  <wsdl:binding name="BookListHTTPBinding"
     type="http://www.w3.org/ns/wsdl/http"
     interface="">
    <wsdl:documentation>
       The RESTful HTTP binding for the book list service.
    </wsdl:documentation>
    <wsdl:operation ref="" whttp:method="GET"/>
  </wsdl:binding>

  <wsdl:service name="BookList" interface="">
    <wsdl:documentation>
       The bookstore's book list service.
    </wsdl:documentation>
    <wsdl:endpoint name="BookListHTTPEndpoint"
       binding="tns:BookListHTTPBinding"
       address="http://www.bookstore.com/books/">
    </wsdl:endpoint>
  </wsdl:service>
</wsdl:description>

定义图书列表服务操作

到目前为止，您已经了解如何处理图书列表 Web 服务并与之通信。接下来您将指定图书列表服务操作，该操作描述图书列表服务的功能。

interface 元素及其子 operation 元素用于定义服务的操作。在该图书列表服务的情况下，您将定义单个操作 getBookList，此操作使用图书列表来响应请求。

下一步，指定 operation 元素的三个属性：

  • pattern：用于指定该操作的消息交换模式（message exchange pattern，MEP）。MEP 定义操作中的消息顺序及其方向。在此例中，请指定值 http://www.w3.org/ns/wsdl/in-out，以指示该服务接收一个输入消息——图书列表请求——并发送一个输出消息——图书列表。为了支持此 MEP，请指定 operation 元素的 input 和 output 子元素。这些元素用于引用定义消息结构的 XML 模式元素，下一部分将创建那些消息结构。
  • style：用于指定有关某个操作的附加信息。请指定值 http://www.w3.org/ns/wsdl/style/iri，从而对 input 元素内容施加限制，例如要求它仅使用 XML 模式元素。
  • wsdlx:safe：在 WSDL 扩展命名空间中，此属性声明该操作是等幂的。这种类型的操作不修改资源，因此可以调用多次并获得相同的结果。为了利用此元素，可以在 description 元素上声明 WSDL 扩展命名空间 http://www.w3.org/ns/wsdl-extensions。

您可以在“WSDL 2.0 Part 2: Adjuncts”（请参阅参考资料以获得链接）中找到预定义的 MEP、样式和 safe 属性定义。

在清单 6 中查看图书列表服务的接口声明。既然现在已经声明了接口和操作，您可以更新 service 和 binding 元素的接口引用和绑定 operation 元素的接口操作引用。


清单 6. 图书列表接口定义

                
<wsdl:description xmlns:wsdl="http://www.w3.org/ns/wsdl"
   targetNamespace="http://www.bookstore.org/booklist/wsdl"
   xmlns:tns="http://www.bookstore.org/booklist/wsdl"
   xmlns:whttp="http://www.w3.org/ns/wsdl/http"
   xmlns:wsdlx="http://www.w3.org/ns/wsdl-extensions">

  <wsdl:interface name="BookListInterface">
    <wsdl:operation name="getBookList"
       pattern="http://www.w3.org/ns/wsdl/in-out"
       style="http://www.w3.org/ns/wsdl/style/iri"
       wsdlx:safe="true">
      <wsdl:documentation>
         This operation returns a list of books.
      </wsdl:documentation>
      <wsdl:input element=""/>
      <wsdl:output element=""/>
    </wsdl:operation>
  </wsdl:interface>

  <wsdl:binding name="BookListHTTPBinding"
     type="http://www.w3.org/ns/wsdl/http"
     interface="tns:BookListInterface">
    <wsdl:documentation>
       The RESTful HTTP binding for the book list service.
    </wsdl:documentation>
    <wsdl:operation ref="tns:getBookList" whttp:method="GET"/>
  </wsdl:binding>

  <wsdl:service name="BookList" interface="tns:BookListInterface">
    <wsdl:documentation>
       The bookstore's book list service.
    </wsdl:documentation>
    <wsdl:endpoint name="BookListHTTPEndpoint"
       binding="tns:BookListHTTPBinding"
       address="http://www.bookstore.com/books/">
    </wsdl:endpoint>
  </wsdl:service>
</wsdl:description>

定义图书列表服务操作消息

图书列表 Web 服务具有两个消息：一个输入消息和一个输出消息。您需要描述特定的消息结构，以便客户端知道要向服务发送什么消息，以及预期服务会返回什么消息。

WSDL 2.0 支持使用多种类型系统来描述消息内容，但是目前仅使用了 XML 模式。本部分不介绍 XML 模式的详细信息。许多应用程序中都使用了 XML 模式，例如 WSDL 1.1，并且存在许多关于它的优秀文章。本部分重点介绍如何将 XML 模式用于图书列表 REST Web 服务，以及如何使用 WSDL 2.0 定义的附加属性来标注模式属性。

要为图书列表 REST Web 服务创建两个消息，您需要创建两个全局元素：

  • getBookList 表示输入消息。其中包含元素序列，包括服务上允许的每个查询参数，即作者、标题、出版商、主题和语言。getBookList 元素的内容仅限于元素，因为您为接口操作指定了 IRI 样式。
  • bookList 表示输出消息。其中包含 book 元素的序列。每个 book 元素包含 title 和 url 属性。title 属性应该是不言而喻的。url 属性是指向图书详细信息 REST Web 服务的链接，该服务返回特定图书的详细信息。

您的 url 属性定义包括两个来自 WSDL 扩展命名空间的属性。属性 wsdlx:interface 和 wsdlx:binding 标识该服务的特定 WSDL 2.0 接口和绑定。工具可以使用此语义信息来自动发现该服务。要利用这些属性，可以在 schema 元素上指定 WSDL 扩展命名空间。此外，还要在 WSDL 2.0 描述中包括图书详细信息服务的命名空间，以引用该服务的接口和绑定。

图书列表服务的 XML 模式如清单 7 所示。您可以在下载部分获取图书详细信息服务的描述。


清单 7. 图书列表服务的 XML 模式

                
<schema xmlns="http://www.w3.org/2001/XMLSchema"
   targetNamespace="http://www.bookstore.org/booklist/xsd"
   xmlns:tns="http://www.bookstore.org/booklist/xsd"
   xmlns:booksvc="http://www.bookstore.org/book/wsdl"
   xmlns:wsdlx="http://www.w3.org/ns/wsdl-extensions"
   elementFormDefault="qualified">
  
  <element name="getBookList" type="tns:getBookListType">
  	<annotation>
  	  <documentation>
         The request element for the book list service.
  	  </documentation>
    </annotation>
  </element>
  
  <element name="bookList" type="tns:bookListType">
    <annotation>
      <documentation>
         The response element for the book list service.
      </documentation>
    </annotation>
  </element>
  
  <complexType name="getBookListType">
    <sequence>
      <element name="author" type="string" minOccurs="0" maxOccurs="unbounded"/>
      <element name="title" type="string" minOccurs="0" maxOccurs="1"/>
      <element name="publisher" type="string" minOccurs="0" maxOccurs="1"/>
      <element name="subject" type="string" minOccurs="0" maxOccurs="1"/>
      <element name="language" type="string" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
  </complexType>

  <complexType name="bookListType">
    <sequence>
      <element name="book" type="tns:bookType" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
  </complexType>

  <complexType name="bookType">
    <attribute name="title" type="string"/>
    <attribute name="url" type="anyURI" 
       wsdlx:interface="booksvc:BookInterface"
       wsdlx:binding="booksvc:BookHTTPBinding"/>
  </complexType>
</schema>

要引用 XML 模式中声明的输入和输出元素，您必须将该模式导入您的 WSDL 文档。要导入某个模式，您可以在 types 部分使用 import 元素，如清单 8 所示。您还需要在接口操作的 input 和 output 元素中添加对 getBookList 和 bookList 元素的引用，并将 XML 模式（图书列表模式）的命名空间声明添加到 description 元素。

清单 8 显示了图书列表 REST Web 服务的完整 WSDL 2.0 描述。可以在下载部分中获取此服务和图书详细信息 REST Web 服务的描述。


清单 8. 图书列表 REST Web 服务的 WSDL 2.0 描述

                
<wsdl:description xmlns:wsdl="http://www.w3.org/ns/wsdl"
   targetNamespace="http://www.bookstore.org/booklist/wsdl"
   xmlns:tns="http://www.bookstore.org/booklist/wsdl"
   xmlns:whttp="http://www.w3.org/ns/wsdl/http"
   xmlns:wsdlx="http://www.w3.org/ns/wsdl-extensions"
   xmlns:xs="http://www.w3.org/2001/XMLSchema"
   xmlns:msg="http://www.bookstore.org/booklist/xsd">
  <wsdl:documentation>
     This is a WSDL 2.0 description of a sample bookstore service
     listing for obtaining book information.
  </wsdl:documentation>

  <wsdl:types>
    <xs:import namespace="http://www.bookstore.org/booklist/xsd"
       schemaLocation="booklist.xsd"/>
  </wsdl:types>

  <wsdl:interface name="BookListInterface">
    <wsdl:operation name="getBookList"
       pattern="http://www.w3.org/ns/wsdl/in-out"
       style="http://www.w3.org/ns/wsdl/style/iri" 
       wsdlx:safe="true">
      <wsdl:documentation>
         This operation returns a list of books.
      </wsdl:documentation>
      <wsdl:input element="msg:getBookList"/>
      <wsdl:output element="msg:bookList"/>
    </wsdl:operation>
  </wsdl:interface>

  <wsdl:binding name="BookListHTTPBinding"
     type="http://www.w3.org/ns/wsdl/http"
     interface="tns:BookListInterface">
    <wsdl:documentation>
       The RESTful HTTP binding for the book list service.
    </wsdl:documentation>
    <wsdl:operation ref="tns:getBookList" whttp:method="GET"/>
  </wsdl:binding>

  <wsdl:service name="BookList" interface="tns:BookListInterface">
    <wsdl:documentation>
       The bookstore's book list service.
    </wsdl:documentation>
    <wsdl:endpoint name="BookListHTTPEndpoint"
       binding="tns:BookListHTTPBinding"
       address="http://www.bookstore.com/books/">
    </wsdl:endpoint>
  </wsdl:service>
</wsdl:description>





回页首

总结

在本文中，您了解了 REST 以及 WSDL 2.0 REST Web 服务如何使用 HTTP 和 XML 来进行通信。RESTful 应用程序以资源为中心而不是以操作为中心。以正式的方式描述 REST Web 服务的价值是使用该描述作为客户端与服务提供者之间的正式契约，并支持工具。WSDL 2.0 支持 REST Web 服务的描述。您逐步地完成了使用 WSDL 2.0 和 XML 模式来描述图书列表 REST Web 服务的过程。

但愿，您将使用这里介绍的步骤来创建图书列表服务的 WSDL 2.0 描述，从而为您自己的 REST Web 服务创建描述。

 

wangxuyang
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
REST 基础（三）：使用 WSDL 2.0 描述 REST Web 服务
03-20
NULL 博文链接：https://j2ee-zhongqi.iteye.com/blog/865641
使用PowerDesigner9.5创建Web服务
03-05
Sybase公司PowerDesigner总设计师XiaoWang撰稿Web服务允许您以标准格式提供现有的或新增的功能，并且允许用户和应用程序从任何位置访问它们。　　PowerDesigner9.5同时针对Microsoft.NET和Java引入了完善的Web服务设计和生成机制。使用PowerDesigner9.5，您可以专注于Web服务的设计，而将所有必需的生成、实现构造的任务交给PowerDesigner完成。　　Web服务概述　　Web服务是一种接口，它描述了在网络上可通过SOAP消息进行访问的操作集合。　　Web服务的接口和部署位置(可选)由WSDL说明。WSDL是一种声明数据类型、消
tinyMOBY:用于BioMoby服务的语义丰富的WSDL 2.0描述符-开源
04-29
BioMoby Web服务未将XML Schema用于数据类型定义，因此可能无法以WSDL语言进行全面描述。 BioMoby依靠其自己的BioMoby Central Registry，可以通过SOAP API查询类型信息，也可以将其视为RDF本体。 tinyMOBY是tinyWSDL WSDL 2.0解析器的扩展，它允许将BioMoby本体嵌入到WSDL 2.0描述符中，从而通过语义注释的Web服务描述提供完整的BioMoby Web服务定义。 该库与BioMoby Central Registry进行交互，并可以使用BioMoby服务标识符（LSID）自动生成适当的WSDL 2.0描述符。 然后可以使用生成的WSDL 2.0描述符来获取MobyCore模型中服务的完整定义，这有助于进一步执行服务。
2基于扩展WSDL行为描述的Web服务组合.pdf
08-25
互联网上存在丰富的Web服务以及自动服务组合方法，但这些自动组合方法(如经典的Roman模型)均要求服务暴露其行为，以此作为服务是否可自动合成的先决条件。现有的Web服务描述文档(如W3C的WSDL标准)缺乏对服务行为的有效描述，使得这些自动化服务组合方法在实际中不可行。针对该问题，提出一种在WSDL中扩展服务行为描述的服务接口方案，基于GMF实现服务行为编辑器，帮助用户在WSDL中协同添加或编辑服务行为，并利用Axis2开源框架开发客户端生成器，根据WSDL中的服务行为反向自动生成具有服务行为的客户端。以k-lokahead算法为例在Sekda服务库中应用该服务方案，实验结果验证了其可行性。
WSDL详解（示例复制粘贴篇）：什么是WSDL？WSDL的作用?WSDL文件如何生成？如何将WSDL文件生成java代码并且调用？
luck_sheng的博客
09-14 4107
WSDL是为描述Web服务发布的XML格式。W3C组织（World Wide Web Consortium）没有批准1.1版的WSDL，当前的WSDL版本是2.0，是W3C的推荐标准（recommendation）（一种官方标准），并将被W3C组织批准为正式标准。WSDL描述Web服务的公共接口。这是一个基于XML的关于如何与Web服务通讯和使用的服务描述；也就是描述与目录中列出的Web服务进行交互时需要绑定的协议和信息格式。
WSDL 1.1 与WSDL 2.0
undergrowth的专栏
06-12 2200
参考： wsdl 2.0 的参考博客--- http://tutorials.jenkov.com/wsdl/index.html WSDL---- Web Service Description Language,用于描述web service的接口--基于xml的用于描述web services以及如何访问web services的语言 Xml相关的概念 WSDL
wsdl 1.1规范，wsdl 2.0规范，两者区别
dynezheng的博客
01-18 1055
wsdl 1.1 : wsdl 分为抽象定义部分和具体定义部分 根为description [code="java"] ... ... ... ... ... [/code] 其中，抽象定义部分为： [b]types[/b]:相当于定义数据的...
创建一个既支持WSDL又支持REST的WCFWebService
田发江的专栏
11-30 7333
创建一个既支持WSDL又支持REST的WCFWebService 首先回顾一下REST,WCF和WebService这三个基本概念。 REST：REST最核心的概念是“资源”，一个uri代表一个特定的资源。使用它的一个好处就是客户端只需要发送一个简单的http包即可操作服务器的资源，没有了SOAP协议包的复杂，以至于使用Javascript就可以轻松的调用REST的服务。 WCF：它是一个分
WebService——WSDL详解
最新发布
吴声子夜歌的博客
12-19 865
W3C组织（World Wide Web Consortium）没有批准1.1版的WSDL，当前的WSDL版本是2.0，是W3C的推荐标准（recommendation）（一种官方标准），并将被W3C组织批准为正式标准。WSDL文档有各种元素，但它们包含在这三个主要元素中，可以作为单独的文档开发，可以将它们组合或重用以形成完整的WSDL文件。WSDL将Web服务分解为三个特定的，可识别的元素，这些元素可以在定义后组合或重用。元素的绑定属性将服务的地址与Web服务中定义的绑定元素相关联。该服务发送一条消息。
另类感受soap和rest风格webservice不同点
万米高空的博客
06-30 7042
最近一直在看webservice方面的东西，但是刚接触webservice是公司业务要去调用别人的webservice接口，一看文档rest风格。然后就一直有个疑云在心中。因为网上看到的是soap的，我博客里入门用的也是soap风格的，却一直不清楚二者的区别，百度看到好多讲的都比较专业，当然也不好看懂。我就借用下soapUI这个软件来直观的体现二者的不同。也比较使用。 点击这里进入soapui下载页
WSDL说明
Hynial的博客
12-30 602
WSDL 是一种XML Application，他将Web服务描述定义为一组服务访问点，客户端可以通过这些服务访问点对包含面向文档信息或面向过程调用的服务进行访问(类似远程过程调用)。WSDL首先对访问的操作和访问时使用的请求/响应消息进行抽象描述，然后将其绑定到具体的传输协议和消息格式上，以最终定义具体部署的服务访问点。相关的具体部署的服务访问点通过组合就成为抽象的Web服务。 WSDL
webService的rest风格的接口发布流程
a_walking_tomcat的博客
09-13 1万+
restful风格服务的发布 步骤 1 在接口中编写抽象方法以及在的实现类中配置相应的实现方法（rest的方法），示例代码如下： @Override @Produces("application/json")//返回值类型 @Consumes("application/x-www-form-urlencoded")//表单提交类型 @Path("rest_ping")//http访问的
把 SOAP 服务转化为 REST 服务(REST Service 的最佳实践，第 3 部分)
凌风探梅的专栏
07-21 2961
from: https://www.ibm.com/developerworks/cn/webservices/1102_mace_restservicePart3/1102_mace_restservicePart3.html?ca=drs- 基于 SOAP 的 Web 服务和 REST 服务的描述 在本系列的前两篇文章中，作者系统的介绍了 REST 服务的核心概念以及 REST 和 S
什么是REST？以及RESTful的实现
leopard0825的专栏
11-07 2146
本文介绍了什么是REST，以及RESTful的实现。简单的说，REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。   Spring3.0将全面支持REST 对于REST中无状态(stateless)的一点认识 基于JavaScript的REST客户端框架 RIA+REST架构实现完美WEB开发 REST构架风格介绍：状...
SOAP和REST区别 自我理解
热门推荐
文艺风程序猿
03-11 1万+
定义 SOAP（Simple Object Access Protocol 简单对象访问协议），用于在Web Service中把远程调用和返回封装成机器可读的格式化数据，事实上SOAP使用XML数据格式，以描述调用的远程过程、参数、返回值和出错信息等等。其实SOAP最早是针对RPC的一种解决方案，很轻量，同时作为应用协议可以基于多种传输协议来传递消息（Http,SMTP等）。但是随着SOAP作为...
如何使用wsdl本地客户端调用webservice服务
05-30
使用WSDL本地客户端调用Web服务的步骤如下： 1. 获取WSDL文件。WSDL文件包含了Web服务的定义信息，可以通过Web浏览器访问Web服务的URL，并在URL后面添加“?wsdl”参数，从而获取WSDL文件。 2. 使用WSDL2Java工具生成客户端代码。WSDL2Java是一个Java开发工具，可以将WSDL文件转换为Java客户端代码。你可以从Apache CXF或Apache Axis等Web服务框架中找到WSDL2Java工具。 以Apache CXF为例，在命令行中输入以下命令生成客户端代码： ``` wsdl2java -p <package-name> -d <output-directory> <wsdl-url> ``` 其中，`<package-name>`是客户端代码的Java包名，`<output-directory>`是客户端代码的输出目录，`<wsdl-url>`是Web服务的WSDL文件URL。 3. 编写客户端代码。在生成的客户端代码中，可以找到代表Web服务的Java接口。你需要实例化该接口，并调用接口中定义的方法来调用Web服务。 ``` // 实例化Web服务接口 ServiceName serviceName = new ServiceName(); WebServicePortType port = serviceName.getWebServicePort(); // 调用Web服务方法 String result = port.webServiceMethod(param1, param2, ...); ``` 其中，`ServiceName`是生成的代表Web服务的Java类，`WebServicePortType`是Web服务接口，`webServiceMethod`是Web服务中定义的方法。 4. 运行客户端代码。你可以将客户端代码打包成一个可执行的Java应用程序，并在命令行中运行该应用程序，从而调用Web服务。 以上是使用WSDL本地客户端调用Web服务的基本步骤。需要注意的是，不同的Web服务框架和工具可能会有所不同，具体步骤请参考相关的文档或教程。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值