Maven WADL 插件没有生成可用的 WADL

Question

我正在尝试使用 maven 插件生成 WADL。项目构建和服务工作。这是带有插件的 POM 部分：

             <plugin>
                <groupId>com.sun.jersey.contribs</groupId>
                <artifactId>maven-wadl-plugin</artifactId>
                <version>1.19.2</version>
                <executions>
                    <execution>
                        <id>generate</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                        <phase>package</phase>
                    </execution>
                </executions>

                <configuration>
                    <wadlFile>${basedir}/src/main/docs/ThingREST.wadl</wadlFile>
                    <formatWadlFile>true</formatWadlFile>
                    <baseUri>http://localhost:8080/ThingREST</baseUri>
                    <packagesResourceConfig>
                        <param>samp.rest.ws.controller</param>
                    </packagesResourceConfig>
                    <wadlGenerators>
                        <wadlGeneratorDescription>
                            <className>com.sun.jersey.server.wadl.generators.WadlGeneratorApplicationDoc
                            </className>
                            <properties>
                                <property>
                                    <name>applicationDocsFile</name>
                                    <value>${basedir}/src/main/docs/xml/app-wadl-doc.xml</value>
                                </property>
                            </properties>
                        </wadlGeneratorDescription>
                        <wadlGeneratorDescription>
                            <className>com.sun.jersey.server.wadl.generators.WadlGeneratorGrammarsSupport
                            </className>
                            <properties>
                                <property>
                                    <name>grammarsFile</name>
                                    <value>${basedir}/src/main/docs/xml/app-wadl-grammar.xml</value>
                                </property>
                            </properties>
                        </wadlGeneratorDescription>                        
                    </wadlGenerators>
                </configuration>
            </plugin>

applicationDocFile 和 grammarFile 存在，但它们不包含任何重要信息。我不确定要包括什么。

这是控制器：

package samp.rest.ws.controller;

import java.util.List;
import samp.rest.ws.ThingDB;
import samp.rest.ws.vo.Thing;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
 *
 * @author Grayson
 */
@RestController
public class ThingController {

    @RequestMapping(value = "/things", method = RequestMethod.GET, headers = "Accept=application/json") //produces = "application/json")
    public List<Thing> getThings() {
        return ThingDB.getThings();
    }

    @RequestMapping(value = "/thing/{id}", method = RequestMethod.GET, headers = "Accept=application/json")
    public Thing getThingById(@PathVariable int id) {
        return ThingDB.getThing(id);
    }

    @RequestMapping(value = "/thingy/{id}", method = RequestMethod.GET)
    public String getThingy(@PathVariable int id) {
        return ThingDB.getThing(id).toString();
    }

    @RequestMapping(value = "/addthing", method = RequestMethod.PUT) //, headers = "Accept=application/json")    
    public void addThing(@RequestBody Thing thing) {
        ThingDB.addThing(thing);

        List<Thing> lt = ThingDB.getThings();
        for (Thing t : lt) {
            System.out.println(" Post add: " + t.toString());
        }
    }
}

最后，这是生成的 WADL：

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://wadl.dev.java.net/2009/02">
    <doc
        jersey:generatedBy="Jersey: 1.19.2 08/25/2016 12:00 AM"
        xmlns:jersey="http://jersey.java.net/"/>
    <doc
        title="Maven Spring REST Sample WADL"
        xml:lang="en"><![CDATA[
        This is the Web Application Description Language (WADL) for
        a Maven Spring REST Service. This service is intended to serve as
        a workign model/sample.
    ]]></doc>
    <grammars/>
    <resources base="http://localhost:8080/ThingREST"/>
</application>

我希望 WADL 包含可用的服务调用并识别输入类型。显然，我不明白这个。

我到处搜索示例和文档以使用此插件。任何和所有帮助将不胜感激。可悲的是，documentation/examples 确实存在的东西似乎已经过时了。

提前致谢。

Answer 1

很遗憾，此插件不支持 Spring REST 控制器。它只会处理使用 @Path 和其他 JAX-RS 注释注释的类。没有其他插件可以满足您的需求。您有两个选择：

1) 重写您的控制器以使用 JAX-RS。例如，我将您的控制器更改为以下内容：

package samp.rest.ws.controller;

import java.util.List;
import samp.rest.ws.ThingDB;
import samp.rest.ws.vo.Thing;

import javax.ws.rs.*;

@Path("/thing")
public class ThingController {

    @GET
    @Path(value = "/things")
    @Produces("application/json")
    public List<Thing> getThings() {
        return ThingDB.getThings();
    }

    @GET
    @Path(value = "/thing/{id}")
    @Produces("application/json")
    public Thing getThingById(@PathParam("id") int id) {
        return ThingDB.getThing(id);
    }

    @GET
    @Path(value = "/thingy/{id}")
    public String getThingy(@PathParam("id") int id) {
        return ThingDB.getThing(id).toString();
    }

    @PUT
    @Path(value = "/addthing")
    @Produces("application/json")
    public void addThing(Thing thing) {
        ThingDB.addThing(thing);

        List<Thing> lt = ThingDB.getThings();
        for (Thing t : lt) {
            System.out.println(" Post add: " + t.toString());
        }
    }
}

然后插件生成这个 WADL 文件：

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://wadl.dev.java.net/2009/02">
    <doc jersey:generatedBy="Jersey: 1.19.2 08/25/2016 12:00 AM" xmlns:jersey="http://jersey.java.net/"/>
    <doc title="A message in the WADL" xml:lang="en"><![CDATA[This is the Web Application Description Language (WADL) for
        a Maven Spring REST Service. This service is intended to serve as
        a workign model/sample.]]></doc>
    <grammars>
        <include href="xsd0.xsd">
            <doc/>
        </include>
    </grammars>
    <resources base="http://localhost:8080/ThingREST">
        <resource path="/thing">
            <resource path="/things">
                <method id="getThings" name="GET">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="/addthing">
                <method id="addThing" name="PUT">
                    <request>
                        <representation mediaType="*/*"/>
                    </request>
                </method>
            </resource>
            <resource path="/thing/{id}">
                <param name="id" style="template" type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"/>
                <method id="getThingById" name="GET">
                    <response>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="/thingy/{id}">
                <param name="id" style="template" type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema"/>
                <method id="getThingy" name="GET">
                    <response>
                        <representation mediaType="*/*"/>
                    </response>
                </method>
            </resource>
        </resource>
    </resources>
</application>

2) 编写您自己的支持 Spring REST 控制器的 Maven WADL 插件。作为参考，你可以以web服务的形式看这个生成器：

https://javattitude.com/2014/05/26/wadl-generator-for-spring-rest/

以及Maven WADL插件源码：

https://github.com/jersey/jersey-1.x/tree/master/contribs/maven-wadl-plugin

Maven WADL 插件没有生成可用的 WADL

Maven WADL plugin not producing a usable WADL

java

rest

plugins

wadl

maven