Tastypie प्रलेखन पीढ़ी

Question

मैं tastypie REST API के लिए API दस्तावेज़ उत्पन्न करने के लिए ऑटो-डॉक टूल का उपयोग करने का प्रयास कर रहा हूं। मैंने tastytool की कोशिश की, लेकिन ऐसा लगता है कि एपीआई के परिणाम पैरामीटर लेकिन मॉडल के कॉलम नहीं दिख रहे हैं। तब मैंने कोशिश की कि स्फिंक्स अधिक आशाजनक प्रतीत होता है क्योंकि टेस्टपी स्पिंक्स का समर्थन करता है, लेकिन मुझे यह दिखाने के लिए कोई उदाहरण नहीं मिल रहा है कि & कोड के अंदर एपीआई के लिए टिप्पणी कैसे डालें, और उन्हें दस्तावेज़ में जेनरेट करें।

कोई भी सही ढंग से टिप्पणी लिखने और Tastypie आधारित API के लिए स्फिंक्स दस्तावेज़ उत्पन्न करने के बारे में कुछ जानकारी या उदाहरण साझा कर सकता है? धन्यवाद।

Answer 1

आप tastypie-swagger पर एक नज़र डालना चाहते हैं, जो Swagger का उपयोग करता है ताकि आपके Tastypie एपीआई के लिए एक/डॉक/पेज उत्पन्न हो सके।

कुछ मामूली अनुकूलन (जो एक स्वादिष्ट संस्करण अंतर के कारण आवश्यक थे, मुझे लगता है) के बाद मुझे कुछ सफलता मिली है।

संपादित करें: रूपांतरों मैं आवश्यक पाया (एक Django संस्करण < 1.4 और tastypie संस्करण> 0.9.11 के कारण) अब tastypie-अकड़ की मुख्य लाइन शाखा में विलय कर दिया गया है।

Answer 2

शायद मैं आपके प्रश्न का बिंदु पूरी तरह से खो रहा हूं लेकिन यदि आप स्रोत वितरण के साथ आने वाले दस्तावेज़ों को बनाने की कोशिश कर रहे हैं तो दस्तावेज़ों में एक मेकफ़ाइल है जो आवश्यक क्रियाएं करता है। आपको एचटीएमएल, जेसन, लेटेक्स इत्यादि जैसे लक्ष्य आउटपुट प्रकार को निर्दिष्ट करने की आवश्यकता है। मैं django, tastypie, और नींद के लिए दस्तावेज़ों की एक स्थानीय प्रतिलिपि रखता हूं क्योंकि मैं एक-दूसरे के साथ संयोजन में तीनों का उपयोग करता हूं और मैं make html विकल्प का उपयोग करता हूं बार बार।

यदि मैं इस बारे में गलत हूं कि आप जो हासिल करने की कोशिश कर रहे हैं, तो शायद हम कुछ स्पष्टीकरण के लिए आ सकते हैं।

Answer 3

वहाँ भी Django Tasty Docs जो मेरे सवाल का स्पष्ट नहीं होने के लिए Tasty Tools