जर्सी आराम एपीआई

Question

दस्तावेज करना मैं जर्सी ढांचे का उपयोग करके बनाए गए मेरे बाकी एपीआई के लिए दस्तावेज उत्पन्न करने का एक तरीका ढूंढ रहा हूं।

क्या ऐसे दस्तावेज उत्पन्न करने के लिए कोई उपकरण हैं? इसके अलावा, बाकी API के दस्तावेज़ों के लिए सर्वोत्तम प्रथाएं क्या हैं।

Answer 1

मैंने कुछ महीने पहले इस पर कुछ शोध किया था और मेरा निष्कर्ष यह था कि जर्सी (और कई अन्य!) आरईएसटी एपीआई दस्तावेज करने के लिए सबसे अच्छा ढांचा "स्वैगर" - http://swagger.io/ है। यह एक ओपन सोर्स प्रोजेक्ट है (https://github.com/swagger-api/swagger-core) और उपयोग/एकीकृत करने के लिए एक बहुत ही सरल है। आप बस अपने आरईएसटी एपीआई में कुछ एनोटेशन जोड़ते हैं और यह सभी एपीआई संसाधनों, अनुरोध/प्रतिक्रिया संदेशों के साथ "वेबसाइट" उत्पन्न करता है और यहां तक ​​कि सीधे वहां से परीक्षण करने की अनुमति देता है।

@POST 
@Produces("application/json") 
@Consumes({ "application/xml", "application/json"}) 
@ApiOperation(
    value = "Short description of resources", 
    notes = "Detailed textual description of the resource...", 
    responseClass = "com.example.data.resps.PostExampleResp") 
@ApiErrors(value = { @ApiError(code = 404, reason = "Resources Not Found"), 
    @ApiError(code = 400, reason = "Bad Request"), 
    @ApiError(code = 500, reason = "Internal Error")}) 
public PostExampleResp postExample(
    @ApiParam(value = "Description of request message", 
     required = true) PostExampleReq request) 
    throws WebApplicationException{ 
    ... 

@Api... एनोटेशन स्वैगर एनोटेशन हैं: यहाँ एक API संसाधन के प्रलेखन का एक उदाहरण है। http://swagger.io/swagger-ui/

कुछ अन्य परियोजनाओं रहे हैं कि, अर्थात्:

• http://enunciate.codehaus.org: यह भी एक दिलचस्प परियोजना की तरह दिखता है, यह अधिक क्लासिक javadocs पालन करने के लिए लगता है आप API दस्तावेज़ यहां की एक लाइव डेमो देख सकते हैं दस्तावेज का प्रकार।

Answer 2

हम miredot पर काम कर रहे हैं। इसे बिना किसी अतिरिक्त एनोटेशन (एम) जोड़ने के बिना बॉक्स के बाहर काम करना चाहिए। कोई प्रतिक्रिया स्वागत है।