2012-06-19 8 views
9

वर्तमान में अनुनाद आरईएसटी एपीआई दस्तावेज उत्पन्न करता है, लेकिन प्रतिक्रिया शरीर में प्रतिक्रिया की JSON संरचना के बारे में जानकारी नहीं है। मेरी समझ में, यदि मैं डेटा इकाइयों के साथ कक्षाओं को शामिल करता हूं जो जर्सी द्वारा जेएसओएन को क्रमबद्ध/डी-धारावाहिक हैं, तो प्रबुद्ध दस्तावेज़ के उस टुकड़े को उत्पन्न करने में सक्षम होंगे।Enunciate द्वारा उत्पन्न दस्तावेज़ों में JSON प्रतिक्रिया बॉडी के प्रारूप को कैसे शामिल करें?

डेटा संस्थाओं एक अलग मॉड्यूल, के रूप में उच्चारित दस्तावेज में सुझाव दिया है जो अपने स्रोतों के साथ पैक किया जाता है में कर रहे हैं - 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

ऐसा लगता है कि डेटा मॉडल अनुभाग के लिए प्रलेखन उत्पन्न करने के लिए, इकाइयों को '@ XmlRoolElement' के साथ एनोटेट किया जाना चाहिए। क्या यह सही है या मैं एक अलग एनोटेशन का उपयोग कर सकता हूं, ताकि एक्सएमएल के बिना दस्तावेज़ों में केवल JSON शामिल किया जा सके? –

+2

'<दस्तावेज़ शीर्षक =" आरईएसटी एपीआई "में शामिल हैं EXXXX =" false "> 'यह सेटिंग xml नमूना की पीढ़ी को अक्षम करती है और केवल JSON छोड़ देती है। –

उत्तर

9

डेटा मॉडल अनुभाग के लिए प्रलेखन जेनरेट करने के लिए, इकाइयों को @XmlRootElement के साथ एनोटेट किया जाना चाहिए।

+0

बिल्कुल सही :) धन्यवाद –

संबंधित मुद्दे