OpenAPI

Шлюз OpenAPI 3.1 құжатын мына мекенжай бойынша береді:

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

Ол шлюз іске қосылғанда әр сервис ұсынатын құжаттардан жиналады: жолдар мен схемалар біріктіріледі, қайталанатындар сервистің атау кеңістігін алады, ал ішкі (тек mesh үшін) деп белгіленген кез келген жол алынып тасталады. Сипаттамалар сервис бойынша қосылады; әлі қосылмаған топтар эндпоинттер анықтамасында бар, бірақ құжатта жоқ. Құжат бүкіл API-ді қамтымайынша, эндпоинттер анықтамасын топтардың негізгі тізімі, ал келісімдер бетін негізгі келісімшарт деп санаңыз.

RolChat-тың әр келісімшарты, құжатта болсын, болмасын, келісімдерге сай келеді: жауап конверті, курсорлық беттеу, идемпотенттілік кілттері, сұрау лимиттерінің тақырыптары және қате кодтары.