OpenAPI

Vārteja sniedz OpenAPI 3.1 dokumentu adresē:

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

Tas tiek salikts vārtejas palaišanas brīdī no dokumentiem, ko iesniedz katrs serviss: ceļi un shēmas tiek apvienoti, dublikātiem tiek piešķirta servisa nosaukumvieta, un jebkurš ceļš, kas atzīmēts kā iekšējs (tikai tīklojumam), tiek noņemts. Ieguldījumi tiek pievienoti serviss pa servisam; saimes, kas vēl nav iesniegtas, parādās galapunktu atsaucē, bet ne dokumentā. Kamēr dokuments neaptver visu virsmu, uzskatiet galapunktu atsauci par autoritatīvo saimju sarakstu un konvenciju lapu par autoritatīvo līgumu.

Katrs RolChat līgums, neatkarīgi no tā, vai tas ir dokumentā, ievēro konvencijas: aploksni, kursora lapošanu, idempotences atslēgas, ātruma ierobežojumu galvenes un kļūdu kodus.