2012-06-19 22 views
9

Hiện tại Enunciate tạo tài liệu REST API, nhưng Nội dung phản hồi không chứa thông tin về cấu trúc JSON của phản hồi. Theo hiểu biết của tôi, nếu tôi bao gồm các lớp với các thực thể dữ liệu được tuần tự hóa/de-serialized bởi Jersey thành JSON, thì enunciate sẽ có thể tạo ra phần tài liệu đó.Cách bao gồm định dạng của Nội dung trả lời JSON trong tài liệu được tạo bởi Enunciate?

Đối tượng dữ liệu đang ở trong một mô-đun khác nhau, được đóng gói với các nguồn của nó như đề xuất trong tài liệu phát âm - 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> 
... 

Đây là cách của tôi enunciate.xml trông giống như:

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

Và cách tài liệu này trông như thế nào:

Documentation Screenshot

Khi bạn thấy Nội dung phản hồi chỉ chứa element: (custom).

Làm cách nào để có cấu trúc JSON của phản hồi?

+1

Dường như để tạo tài liệu cho phần Mô hình dữ liệu, các thực thể phải được chú thích bằng '@ XmlRoolElement'. Điều đó đúng hay tôi có thể sử dụng một chú thích khác, để chỉ bao gồm JSON trong các tài liệu không có XML? –

+2

'' Thiết lập này vô hiệu hóa việc tạo mẫu xml và chỉ để lại JSON. –

Trả lời

9

Để tạo tài liệu cho phần Mô hình dữ liệu, các thực thể cần được chú thích với @XmlRootElement.

+0

Hoàn hảo :) Cảm ơn –

Các vấn đề liên quan