Использование Enanciate для документирования API-интерфейса Spring MVC REST

У меня есть приложение 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.

У кого-нибудь есть рабочий образец контроллеров Spring/REST/JSON, работающих с enunciate?

Спасибо!

1 ответ

Решение

К сожалению, Enunciate поддерживает только стандартные аннотации интерфейса JAX-RS. Spring MVC пока не поддерживается. Вот где мы отслеживаем эту работу.

Другие вопросы по тегам