2011-01-30 11 views
13

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

मैं विशेष रूप से प्रलेखन उपकरण जो JSON और AMQP के लिए कम से कम कुछ समर्थन में दिलचस्पी है, लेकिन सवाल यह भी Protobuf, Thrift जैसी चीजों के लिए खड़े हैं, और XML-RPC और किसी भी उपकरण सुझाव है कि उन तकनीकों के साथ काम पर होगा कम से कम मुझे शुरू करने के लिए एक जगह दे दो।

मैं ईमानदारी से किसी भी आरपीसी इंटरफ़ेस (या तो हाथ से या किसी उपकरण द्वारा उत्पादित) के लिए गुणवत्ता दस्तावेज देखना नहीं चाहता हूं, और मुझे उम्मीद है कि डेवलपर्स आलसी हैं और इसलिए नहीं कि उपकरण मौजूद नहीं हैं।

+0

इसी तरह का प्रश्न? http://stackoverflow.com/questions/6254171/what-is-the-best-tool-for-documenting-generate-reference-for-a-restful-http-rpc – Pranalee

उत्तर

1

स्वैगर (http://swagger.wordnik.com) पर एक नज़र डालें - यह हम 3scale (http://www.3scale.net) पर हमारे सभी एपिस के लिए उपयोग करते हैं। असल में यह एक JSON spec ले जाएगा और आपके लिए इंटरैक्टिव एपीआई दस्तावेज़ बनाने सहित विभिन्न चीजें करेगा। आरपीसी शैली दस्तावेज़ ठीक होना चाहिए (हमने एक्सएमएल लेने/प्राप्त करने के लिए इसे संशोधित किया)। विभिन्न भाषाओं के लिए कोड से चश्मा उत्पन्न करने के लिए उपकरण भी हैं।

आखिरकार, एक साधारण कोड निकालने वाला टूल है जो JSON: https://github.com/solso/source2swagger बना सकता है। यह सब Doxygen आदि से कम औपचारिक है लेकिन जांच के लिए उपयोगी हो सकता है।

+0

+1 बहुत अच्छा। हमने हाथ से कुछ लागू किया जो अनिवार्य रूप से वही काम करता है। लेकिन, यह बहुत बेहतर है। अच्छा काम! – Homer6

संबंधित मुद्दे