2012-06-19 10 views
9

Actualmente Enunciate genera la documentación REST API, pero Response Body no contiene la información sobre la estructura JSON de la respuesta. Según entiendo, si incluyo las clases con las entidades de datos serializadas/de-serializadas por Jersey a JSON, enunciate podría generar esa parte de la documentación.Cómo incluir el formato del cuerpo de respuesta JSON en los documentos generados por Enunciate?

Las entidades de datos se encuentran en un módulo diferente, que se empaqueta con sus fuentes como se sugiere en la documentación enunciado - 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> 
... 

Así es como mi enunciate.xml parece:

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

Y esto cómo los documentos se parecen:

Documentation Screenshot

Como ve, el cuerpo de respuesta contiene solo element: (custom).

¿Cómo hacer que contenga la estructura JSON de la respuesta?

+1

Parece que para generar la documentación para la sección del Modelo de datos, las entidades deben anotarse con '@ XmlRoolElement'. ¿Es correcto o puedo usar una anotación diferente para incluir solo el JSON en los documentos sin el XML? –

+2

'' Esta configuración deshabilita la generación de la muestra xml y solo deja el JSON. –

Respuesta

9

Para generar la documentación para la sección del Modelo de datos, las entidades deben anotarse con @XmlRootElement.

+0

Perfecto :) Gracias –

Cuestiones relacionadas