तकनीकी API दस्तावेज़ लेखक

हमारा REST API चालीस से अधिक एंडपॉइंट्स तक बढ़ गया है और, इस समय, इनमें से कोई भी दस्तावेजित नहीं है। हमारे साथ एकीकृत करने वाले डेवलपर्स प्रभावी रूप से उदाहरण अनुरोधों से API को रिवर्स-इंजीनियर कर रहे हैं, जिससे सभी की गति धीमी हो जाती है और टालने योग्य समर्थन प्रश्नों की एक स्थिर धारा उत्पन्न होती है। हम इसे सही तरीके से ठीक करना चाहते हैं, एक पूर्ण OpenAPI 3.0 स्पेसिफिकेशन के साथ एक पॉलिश डेवलपर पोर्टल कमीशन करके जिसे लोग वास्तव में पढ़ सकें और चीजों को आजमा सकें।

हम किसी ऐसे व्यक्ति की तलाश कर रहे हैं जो मजबूत तकनीकी लेखन को वास्तविक हाथों के API अनुभव के साथ जोड़ता हो, क्योंकि यह काम स्पष्ट व्याख्या के साथ-साथ सटीक स्कीमाओं के बारे में भी है। आप हर एंडपॉइंट, इसके अनुरोध और प्रतिक्रिया स्कीमाओं और इसके त्रुटि कोडों को कवर करने वाला एक पूर्ण OpenAPI 3.0 YAML स्पेक तैयार करेंगे, फिर उसे Swagger UI या Redoc के साथ होस्ट की गई इंटरैक्टिव दस्तावेज़ों में बदल देंगे। संदर्भ के शीर्ष पर, हमें एक Getting Started गाइड की आवश्यकता है जो प्रमाणीकरण, दर सीमाएँ, पृष्ठांकन और त्रुटि हैंडलिंग के माध्यम से चलती है, साथ ही प्रत्येक प्रमुख एंडपॉइंट के लिए cURL, PHP और JavaScript में कॉपी-पेस्ट कोड उदाहरण। इसे एक Postman संग्रह और संस्करण इतिहास के लिए एक चेंज लॉग टेम्पलेट के साथ पूरा करें।

हम API एक्सेस, हमारे मौजूदा आंतरिक कोड दस्तावेज़ और पूर्ण एंडपॉइंट सूची प्रदान करेंगे; हम 21 दिनों के भीतर समाप्त दस्तावेज़ की अपेक्षा कर रहे हैं।

डिलिवरेबल्स:
— 1. OpenAPI 3.0 YAML स्पेक — सभी एंडपॉइंट्स, अनुरोध/प्रतिक्रिया स्कीमाएँ, त्रुटि कोड
— 2. इंटरैक्टिव API दस्तावेज़ — Swagger UI या Redoc होस्टेड पृष्ठ
— 3. Getting Started गाइड — प्रमाणीकरण, दर सीमाएँ, पृष्ठांकन, त्रुटियाँ
— 4. कोड उदाहरण — cURL, PHP, JavaScript प्रत्येक प्रमुख एंडपॉइंट के लिए
— 5. चेंज लॉग — संस्करण इतिहास टेम्पलेट
— 6. Postman संग्रह निर्यात

प्रक्रिया:
— हम प्रदान करते हैं: API एक्सेस, मौजूदा कोडबेस दस्तावेज़, एंडपॉइंट सूची
— आप प्रदान करते हैं: 21 दिनों में पूर्ण दस्तावेज़
— मजबूत तकनीकी लेखन और API अनुभव की आवश्यकता है