9

目前 Enunciate 生成 REST API 文档,但响应正文不包含有关响应的 JSON 结构的信息。据我了解,如果我包含由 Jersey 序列化/反序列化为 JSON 的数据实体的类,则 enunciate 将能够生成该文档。

数据实体位于不同的模块中,该模块与其源代码一起打包,如发音文档 -多模块项目中所建议的那样

...
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>2.1.2</version>
    <executions>
        <execution>
            <id>attach-sources</id>
            <phase>package</phase>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>
...

这就是我的enunciate.xml的样子:

<?xml version="1.0"?>
<enunciate label="someapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="http://enunciate.codehaus.org/schemas/enunciate-1.25.xsd">

    <api-import pattern="com.something.business.vo.**"/>
    <api-import pattern="com.something.business.domain.**"/>

    <api-classes>
        <include pattern="com.something.web.ssoApi.rest.*"/>
        <include pattern="com.something.business.vo.**"/>
        <include pattern="com.something.business.domain.**"/>
    </api-classes>

</enunciate>

这就是文档的样子:

文档截图

如您所见,响应正文仅包含element: (custom).

如何使其包含响应的 JSON 结构?

4

1 回答 1

9

为了生成数据模型部分的文档,实体应该用@XmlRootElement.

于 2012-06-20T12:14:22.883 回答