如何在Enunciate生成的文档中包含JSON Response Body的格式?

时间:2012-06-19 08:24:17

标签: maven enunciate

目前Enunciate生成REST API文档,但 Response Body 不包含有关响应的JSON结构的信息。根据我的理解,如果我将类包含在由Jersey to JSON序列化/反序列化的数据实体中,则enunciate将能够生成该文档的那一部分。

数据实体位于不同的模块中,该文件与enceiate文档中建议的源包装在一起 - Multi-Module Projects

...
<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>

这就是文档的样子:

Documentation Screenshot

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

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

1 个答案:

答案 0 :(得分:9)

为了生成“数据模型”部分的文档,应使用@XmlRootElement注释实体。