REST API दस्तावेज़ पीढ़ी

Question

वहाँ एक पुस्तकालय है कि बाकी API दस्तावेज़ लिखने के लिए एक मार्कअप प्रदान करता है? मैंने देखा है कई कंपनियों के समान प्रलेखन पैटर्न का उपयोग, उदाहरण के लिए:

http://api.teamlab.com/2.0/

http://www.fullcontact.com/docs/?category=person

मैं अगर वे एक ही पुस्तकालय या सेवा का उपयोग कर रहे सोच रहा हूँ। अनिवार्य रूप से, पुस्तकालय को मार्कअप टेक्स्ट के आधार पर एपीआई नेविगेशन, खोज और प्रदर्शन (रूबी दस्तावेज के लिए यार्ड की तरह) के लिए पेज जेनरेट करना चाहिए।

यह मैं अब तक क्या पाया है है:

• rapi_doc gem। उपयोग पर चर्चा करने के लिए यहां एक article है।

Answer 1

आप निश्चित रूप से Swagger पर एक नजर है चाहिए।

यह मुक्त स्रोत, एपीआई के सैकड़ों और भी नाम सक्रिय डॉक्स के तहत अपने एपीआई प्रबंधन समाधान में 3scale द्वारा प्रयोग किया जाता द्वारा प्रयोग किया जाता है।

Answer 2

माशेरी से IO/Docs देखें।

मैसीरी आई/ओ डॉक्स, अगली पीढ़ी के एपीआई दस्तावेज और अन्वेषण, डेवलपर्स को सीधे अपने दस्तावेज़ों से लाइव एपीआई कॉल निष्पादित करने दें। सोचें कि दस्तावेज़ एक सुविधाजनक, इंटरैक्टिव इंटरफ़ेस में परीक्षण और डिबगिंग से मिलते हैं।

महान दस्तावेज़ों के दूसरे उदाहरण के लिए Parse API Docs देखें।

इसके अलावा, हम FullContact API Docs को डिजाइन करने में बहुत समय बिताया। हम Apigee Live API Console का भी उपयोग करते हैं।

Answer 3

यह API documentaion (Rails4 और Rails5)

ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0 के लिए एक उपयोगी मणि है।

यह सेटअप करने के लिए बहुत आसान है और एक अच्छा उपयोगकर्ता अनुभव है।