एपीआई दस्तावेज कैसे उत्पन्न करें

Question

मुझे एक आरईएसटी एपीआई के लिए कुछ एपीआई दस्तावेज लिखने की जरूरत है जो मैंने बनाया है। क्या ऐसे टूल्स हैं जो स्टाइल में अंडरस्कोर एपीआई दस्तावेज के समान एक अच्छा एचटीएमएल आउटपुट तैयार करेंगे? या शायद कुछ ऐसा जो ट्विटर बूटस्ट्रैप स्टाइल एचटीएमएल के रूप में कुछ आउटपुट करेगा?

मुझे लगता है कि डॉको कोड को नाराज करता है, लेकिन मैं वास्तव में केवल एपीआई दस्तावेज करना चाहता हूं। आदर्श रूप में मैं नियंत्रक फ़ाइल पर एक उपकरण को इंगित करना चाहता हूं और इसे विधियों और मार्गों के बारे में दस्तावेज उत्पन्न करना चाहता हूं लेकिन जब तक कि मैं विशेष रूप से उदाहरणों को कॉल नहीं करता तब तक कोई स्रोत कोड नहीं दिखाता।

Answer 1

apiDoc आपके स्रोत कोड में एपीआई एनोटेशन से एक दस्तावेज बनाता है।

एकीकृत एक एपीआई इतिहास है, जिसमें विभिन्न एपीआई संस्करण स्तरों की तुलना की जा सकती है। तो इसे अंतिम संस्करण के बाद से एपीआई में क्या बदला गया है उसे वापस ले लिया जा सकता है।

डेमो: http://apidocjs.com/example

Github: https://github.com/apidoc/apidoc

Answer 2

गीथब - http://github.com/mashery/iodocs पर I/O डॉक्स देखें। यह नोड.जेएस में हैक किया गया है, और इसमें बहुत से समुदाय योगदान/भागीदारी है।

• http://iodocs.docusign.com
• http://console.datasift.com/datasift

उबेर सरल विन्यास स्कीमा (JSON), और नरक, अगर आप JSON में हाथ से यह सब वर्णन करने के लिए नहीं करना चाहती: यह जंगली में काम को देखने के लिए , का उपयोग मैं/हे डॉक्टर, एक यूआई के साथ आयात करने/JSON कॉन्फ़िगरेशन के निर्माण के लिए एक वेब आधारित उपकरण:

• http://iodoctor.net/

इसके अलावा Github पर उपलब्ध

https://github.com/brandonmwest/iodoctor

पर अगर मैं मदद कर सकते हैं आरंभ करने के लिए मुझे जानते हैं। I/O डॉक्स रेपो में बहुत से उदाहरण कॉन्फ़िगरेशन हैं। ध्यान रखें।

Answer 3

आई/ओ डॉक्स या स्वैगर, जो सबसे लोकप्रिय रीस्टफुल एपीआई दस्तावेज सिस्टम हैं। RAML और Apiary भी है।

Answer 4

test2doc.js आप अपने परीक्षण/चश्मा से API दस्तावेज़ उत्पन्न मदद करता है। तो आप हमेशा नवीनतम अपडेट-टू-डेट एपीआई दस्तावेज प्राप्त कर सकते हैं, वास्तविक अनुरोध/प्रतिक्रिया डेटा के साथ आबादी।

टेस्ट कोड उदाहरण:

const doc = require('test2doc') 
const request = require('supertest') // We use supertest as the HTTP request library 
require('should') // and use should as the assertion library 

// For Koa, you should exports app.listen() or app.callback() in your app entry 
const app = require('./my-express-app.js') 

after(function() { 
    doc.emit('api-documentation.apib') 
}) 

doc.group('Products').is(doc => { 
    describe('#Products', function() { 
    doc.action('Get all products').is(doc => { 
     it('should get all products', function() { 
     // Write specs towards your API endpoint as you would normally do 
     // Just decorate with some utility methods 
     return request(app) 
      .get(doc.get('/products')) 
      .query(doc.query({ 
      minPrice: doc.val(10, 'Only products of which price >= this value should be returned') 
      })) 
      .expect(200) 
      .then(res => { 
      body = doc.resBody(res.body) 
      body.desc('List of all products') 
       .should.not.be.empty() 
      body[0].should.have.properties('id', 'name', 'price') 
      body[0].price.desc('Price of this product').should.be.a.Number 
      }) 
     }) 
    }) 
    }) 
})