Kvaliteetne dokumentatsioon on oluline, et teha API lihtne mõista, rakendada ja säilitada. Loome automaatse dokumentatsiooni põlvkonna, mis põhineb OpenAPI spetsifikatsioonidel, kasutades Swagger UI ja Redoc, kaks populaarsemat API visualiseerimise tööriista.
See võimaldab teil pakkuda arendajatele interaktiivse liidese, kus saate õppida meetodite struktuuri, testida päringuid, ja kiiresti ühendada oma API.
Mis dokumentides sisaldub
| Sektsioon | Kirjeldus |
|---|---|
| Tulemusnäitajad ja meetodid | Marsruutide täielik loetelu, HTTP meetodid, parameetrid, päised |
| Valimi taotlused/vastused | Skriptid curl, Postimees, JavaScript, Python ja muud keeled |
| Luba | Toetus JWT, OAuth2, API võti otse liidesest |
| Rajatise skeemid | Mudelite, pesakondade ja andmenõuete kirjeldus |
| Veakoodid | Kõik võimalikud olekud koos selgitustega |
Tööriistad, mida me kasutame
Swagger UI - interaktiivne dokumentatsioon brauseris, võimega testida
Redoc on loetav, staatiline liides ideaalne avaldamiseks saidil
OpenAPI 3. 0/3. 1-The BOM formaat, millel kõik põhineb
Automaatne genereerimine koodist - märkused, kirjeldused, versioonid ja dokumentatsiooni uuendused automaatselt
Eksport JSON/YAML/HTML
Kasu meeskonnale ja partneritele
Uute arendajate pardale võtmise kiirendamine
Integratsioonivigade vähendamine
Alati ajakohastatud, koodiga sünkroniseeritud dokumentatsioon
Kiire integratsiooni alustamine ilma tehnilise toeta
Avaliku või erasektori portaalide dokumentide lihtne avaldamine
Kus eriti oluline
Avatud APId välisarendajatele
Aktiivse arenguga sisemised APId
B2B integratsiooniga platvormid ja SDKd
Eeskirjad ja skeemide valideerimine
Swagger ja Redoc on järgmise põlvkonna API dokumentatsiooni standard. Loome dokumentide põlvkonna, uuendamise ja avaldamise, et iga arendaja saaks hakata integreerima oma API mõne minuti jooksul.