एक आरईएसटी एपीआई दस्तावेज उत्पन्न करने का सबसे अच्छा तरीका क्या है?

Question

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

कोई भी व्यक्ति के पास कोई विचार है? मुझे पता है कि मैं थोड़ा अस्पष्ट हूं, लेकिन, ईमानदार होने के लिए, मुझे पूरा यकीन नहीं है कि मैं यहां क्या देख रहा हूं - मुख्य रूप से दस्तावेज़ीकरण का प्रबंधन करने का एक आसान तरीका।

Answer 1

According to Roy:

"A REST API should spend almost all of its descriptive 
effort in defining the media type(s) used for representing 
resources and driving application state, or in defining 
extended relation names and/or hypertext-enabled mark-up 
for existing standard media types." 

स्व descriptiveness बाकी के लाभों में से एक है।

Answer 2

आरईएसटी नहीं होने पर, मैंने एक XML-RPC एपीआई दस्तावेज करने के लिए Sphinx का उपयोग किया जिसमें एक एपीआई संदर्भ और एक ट्यूटोरियल शामिल था। स्फिंक्स ने ReStructuredText पर कुछ आसान निर्देश दिए हैं जो आपने जो कुछ पूछा है, उसे प्राप्त करने के लिए: पुनर्वित्तित पाठ स्वरूपित-पाठ फ़ाइलों का संग्रह जो स्फिंक्स HTML और पीडीएफ में बदल जाता है, सामग्री और तालिका के साथ पूर्ण हो जाता है। स्फिंक्स का उपयोग करना आसान है और अच्छी तरह से प्रलेखित है; मुझे नहीं लगता कि यह कहना बेहद असाधारण होगा कि आप इसके बारे में दस मिनट में शुरू कर सकते हैं।

Answer 3

कुछ विश्वसनीय सिस्टम वास्तव में अपना स्वयं का एपीआई लिखने में सक्षम हैं। RESTx पर एक नज़र डालें, जो केवल यही करता है: आप अपने घटकों को लिखते हैं और फिर सर्वर पर उन घटकों के लिए पैरामीटर भेजकर नई वेब सेवाएं बनाते हैं (या तो JSON या वेब फ़ॉर्म के माध्यम से)। फिर आप उन पैरामीटर के लिए एक यूआरआई वापस प्राप्त करते हैं। इसे एक्सेस करने से पैरामीटर के साथ घटक को कॉल किया जाता है और आप परिणाम पुनर्प्राप्त करते हैं।

किसी भी दर पर, घटकों के साथ-साथ निर्मित रीस्टफुल वेब सेवाओं को स्वचालित रूप से जेनरेट किया गया दस्तावेज़ मिलता है, जो ब्राउज़ करने योग्य होता है और HTML या JSON प्रारूप में पुनर्प्राप्त किया जा सकता है।