Как включить формат тела ответа JSON в документы, созданные Enunciate?

В настоящее время Enunciate создает документацию REST API, но тело ответа не содержит информации о структуре ответа JSON. Насколько я понимаю, если я включу классы с объектами данных, которые сериализуются/десериализуются Джерси в 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?


maven enunciate
person Vladimir Tsvetkov    schedule 19.06.2012    source источник
comment
Похоже, что для создания документации для раздела «Модель данных» сущности должны быть аннотированы с помощью @XmlRoolElement. Это правильно или я могу использовать другую аннотацию, чтобы включать в документы только JSON без XML?   -  person Vladimir Tsvetkov    schedule 19.06.2012
comment
<docs title="REST API" includeExampleXml="false"></docs> Этот параметр отключает создание образца XML и оставляет только JSON.   -  person Vladimir Tsvetkov    schedule 19.06.2012

Ответы (1)


arrow_upward
9
arrow_downward

Чтобы сгенерировать документацию для раздела «Модель данных», объекты должны быть аннотированы с помощью @XmlRootElement.

person Vladimir Tsvetkov    schedule 20.06.2012