OpenAPI

गेटवे OpenAPI 3.1 दस्तावेज़ यहाँ देता है:

GET https://api.rolchat.com/openapi.json

यह गेटवे के शुरू होने पर हर सेवा के योगदान किए गए दस्तावेज़ों से बनता है: पथ और स्कीमा मर्ज होते हैं, डुप्लिकेट को सेवा के अनुसार नेमस्पेस मिलता है, और आंतरिक (केवल मेश के लिए) चिह्नित हर पथ हटा दिया जाता है। योगदान सेवा दर सेवा जोड़े जाते हैं; जिन फ़ैमिली ने अभी योगदान नहीं दिया है वे एंडपॉइंट संदर्भ में दिखती हैं लेकिन दस्तावेज़ में नहीं। जब तक दस्तावेज़ पूरी सतह को कवर नहीं करता, एंडपॉइंट संदर्भ को फ़ैमिली की आधिकारिक सूची और परिपाटियों वाले पेज को आधिकारिक अनुबंध मानें।

RolChat का हर अनुबंध, दस्तावेज़ में हो या न हो, परिपाटियों का पालन करता है: एनवेलप, कर्सर पेजिनेशन, आइडेम्पोटेंसी कुंजियाँ, दर-सीमा हेडर और त्रुटि कोड।