REST 应用的描述

Java RESTful

• REST 应用的描述

  WADL(Web Application Description Language，web 应用描述语言)是用于描述基于 http rest web 部署情况，以 XML 格式，支持多种数据类型的描述，展示当前 REST 环境中所提供的 REST 服务接口。

  • 应用的描述

    • application WADL path:

        http://localhost:8080/***/webapi/application.wadl
      

      可以浏览 wadl 的 schema 结构：

      • tag application
        • doc
        • grammars
        • resources

          resources是应用提供的资源集合，至少包含 application.wadl，以及应用中包含的资源描述。

  • 资料的描述

    • 展开 myresource 来查看具体某个方法的 WADL，也可以通过发送一条请求并定义请求头信息来获取。

        curl -X OPTIONS -H "Allow: application/vnd.sun.wadl+xml" -v http://localhost:8080/***/webapi/myresource
      

  • WADL 的配置

    • 配置 jersey.config.server.wadl.disableWadl=true 实现 wadl 自动生成：

        // code config
        public class AirResourceConfig extends ResourceConfig {
        
            public AirResourceConfig() {
                property(ServerProperties.WADL_FEATURE_DISABLE, true);
                packages("com.example.s2x.c3");
            }
        }
        
        // web.xml servlet start param
        <servlet>
            <servlet-name>com.example.AirApplication</servlet-name>
            <init-param>
              <param-name>jersey.config.server.wadl.disableWadl</param-name>
              <param-value>true</param-value>
            </init-param>
        </servlet>