OpenAPI

تقدّم البوابة مستند OpenAPI 3.1 على:

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

يُجمَّع المستند عند بدء تشغيل البوابة من المستندات التي تساهم بها كل خدمة: تُدمج المسارات والمخططات، وتُوضع المكررات في مساحات أسماء حسب الخدمة، ويُزال أي مسار معلَّم كداخلي (داخل الشبكة فقط). تُضاف المساهمات خدمة بعد خدمة؛ والعائلات التي لم تساهم بعد تظهر في مرجع نقاط النهاية لكن ليس في المستند. إلى أن يغطي المستند الواجهة كلها، اعتبر مرجع نقاط النهاية القائمة المرجعية للعائلات، وصفحة الاصطلاحات العقد المرجعي.

كل عقد في RolChat، سواء في المستند أم لا، يتبع الاصطلاحات: الغلاف، والترقيم بالمؤشر، ومفاتيح عدم التكرار، وترويسات حدود المعدل، ورموز الأخطاء.