9

現在、Enunciate は REST API ドキュメントを生成しますが、応答本文には応答の JSON 構造に関する情報が含まれていません。私の理解では、Jersey によって JSON にシリアル化/逆シリアル化されたデータ エンティティを含むクラスを含めると、enunciate はそのドキュメントの一部を生成できます。

データ エンティティは別のモジュールにあり、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 に答える