OpenAPI

Şlüz OpenAPI 3.1 sənədini bu ünvanda təqdim edir:

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

O, şlüz işə düşərkən hər xidmətin təqdim etdiyi sənədlərdən yığılır: yollar və sxemlər birləşdirilir, dublikatlar xidmət üzrə ad sahəsinə salınır və daxili (yalnız mesh üçün) kimi işarələnmiş hər yol silinir. Töhfələr xidmət-xidmət əlavə olunur; hələ töhfə verməmiş ailələr endpoint istinadında görünür, lakin sənəddə yoxdur. Sənəd bütün səthi əhatə edənə qədər endpoint istinadını ailələrin etibarlı siyahısı, qaydalar səhifəsini isə etibarlı müqavilə kimi qəbul edin.

Sənəddə olub-olmamasından asılı olmayaraq, hər RolChat müqaviləsi qaydalara əməl edir: zərf, kursorla səhifələmə, idempotentlik açarları, sorğu limiti başlıqları və xəta kodları.