使用Java Restful Web服务发布doc生成问题

Question

尝试使用我的JAVA restful webservice项目的enunciate插件生成REST文档。每当我使用maven构建运行POM.xml时。我得到了以下警告，而且doc根本没有产生..

[警告] [docs]找不到Splash包com.layer.rest.service.interfaces。没有包含启动文档。

任何线索？

Answer 1

在enunciate.xml中定义的包中尝试使用package-info.java中的JavaDoc，如下所示：

<enunciate label="Foo" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modules>
    <docs title="My Foo API"
        splashPackage="org.foo"  />

根据此配置，enunciate将查找org.foo.package-info.java。如果找不到，则会显示您收到的警告。

有关详细信息，请参阅此处的docs模块文档：https://github.com/stoicflame/enunciate/wiki/Module-Docs