Question

我有一个Spring 3应用程序，我正在尝试生成强大的api文档。我已经尝试了一些不同的项目，并且看到enunicate（http://enunciate.codehaus.org）是否符合我的需求，包括生成swagger格式化文档的能力。

我已将依赖项添加到我的pom.xml文件中，如下所示

        <plugin>
            <groupId>org.codehaus.enunciate</groupId>
            <artifactId>maven-enunciate-spring-plugin</artifactId>
            <version>1.27</version>
            <configuration>
                <configFile>enunciate.xml</configFile>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>assemble</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

并在我的应用根目录中创建了一个简单的enunciate.xml文件：

<?xml version="1.0"?>
<enunciate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://enunciate.codehaus.org/schemas/enunciate-1.28.xsd">   
<services>
    <rest defaultRestSubcontext="/"/>
    <soap defaultSoapSubcontext="/"/>
</services>
<webapp mergeWebXML="src/main/webapp/WEB-INF/web.xml" />
<modules>
    <spring-app disabled="false"></spring-app>
    <docs docsDir="api" splashPackage="com.welflex.rest" title="Web Service API"
        copyright="MyCo"/>
    <obj-c disabled="true"></obj-c>
    <c disabled="true"/>
    <csharp disabled="true"></csharp>
    <swagger disabled="false"></swagger>
</modules>
</enunciate>

当我对我的项目运行mvn clean包时，只会选择几个带有jax-ws注释的类。

有没有人有弹簧/ REST / JSON控制器的工作样本使用enunciate？

谢谢！

Answer 1

不幸的是，Enunciate仅支持标准的JAX-RS接口注释。 Spring MVC还没有得到支持。 Here's where we're tracking that work

使用Enanciate记录Spring MVC REST API

1 个答案: