OpenAPI
OpenAPI मशीन-पठनीय स्कीमा है जो REST API के हर एंडपॉइंट, पैरामीटर और प्रतिक्रिया का वर्णन करती है, और जिससे क्लाइंट बनते हैं।
विस्तार से
यह API एक OpenAPI 3.1 दस्तावेज़ के साथ llms.txt सूचकांक भी प्रकाशित करता है, जिससे कोई SDK जेनरेटर, Postman कलेक्शन या एजेंट फ़्रेमवर्क बिना पहले गद्य पढ़े इसकी पूरी सतह समझ लेता है। अनुरोध के ढाँचे और स्टेटस कोड के लिए यही आधिकारिक स्रोत है। व्यवहार में होने वाले बदलाव लागू होने से पहले चेंजलॉग पर बताए जाते हैं, ताकि बना हुआ क्लाइंट टूटा हुआ मिलने के बजाय सोच-समझकर दोबारा बनाया जा सके।
इसे यह भी कहते हैं
- swagger
- api schema