एपीआई दस्तावेज़ीकरण और डेवलपर पोर्टल (OpenAPI 3.0)

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

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

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

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

प्रक्रिया:
— हम प्रदान करते हैं: API एक्सेस, कोड दस्तावेज़ीकरण, एंडपॉइंट्स की सूची
— आप: 21 दिनों में पूर्ण दस्तावेज़ीकरण