Ҳуҷҷатҳои босифат барои осон кардани фаҳмидан, татбиқ ва нигоҳдории API-ҳо муҳиманд. Мо тавлиди автоматикии ҳуҷҷатҳоро дар асоси мушаххасоти OpEN API бо истифода аз Swagger UI ва Redoc, ду воситаи маъмултарини визуализатсияи API насб кардем.
Ин ба шумо имкон медиҳад, ки таҳиягаронро бо интерфейси интерактивӣ таъмин кунед, ки дар он шумо сохтори усулҳо, дархостҳои санҷиширо омӯзед ва зуд ба API пайваст шавед.
Он чизе ки ба ҳуҷҷатгузорӣ дохил карда шудааст
| Фасл | Тасвирот |
|---|---|
| Нуқтаҳо ва усулҳо | Рӯйхати пурраи хатсайрҳо, усулҳои HTTP, параметрҳо, сарлавҳаҳо |
| Дархостҳо/ҷавобҳои намунавӣ | Скриптҳо барои curl, Postman, Javascript, Python ва дигар забонҳо |
| Авторизатсия | Дастгирии JWT, OAuth2, API Key бевосита аз интерфейс |
| Диаграммаҳои иншоот | Тавсифи моделҳо, сохторҳои лона ва талаботи маълумот |
| Рамзҳои хато | Ҳама ҳолати имконпазир бо тавзеҳот |
Воситаҳое, ки мо истифода мебарем
Swagger UI - ҳуҷҷатҳои интерактивӣ дар браузер, бо қобилияти санҷиш
Redoc интерфейси хондан ва статикӣ барои нашр дар сайт беҳтарин аст
Кушодани API 3. 0/3. 1-The формати BOM, ки дар он ҳама чиз асос ёфтааст
Тавлиди худкор аз рамз - эзоҳҳо, тавсифҳо, версияҳо ва навсозиҳои ҳуҷҷатгузорӣ ба таври худкор
Содирот ба JSON/YAML/HTML
Фоидаҳо барои гурӯҳ ва шарикон
Суръат бахшидан ба боркунии таҳиягарони нав
Кам кардани хатогиҳои ҳамгироӣ
Ҳамеша ҳуҷҷатҳои замонавӣ, ҳамоҳангшудаи код
Оғози зуд ба ҳамгироӣ бе дастгирии техникӣ
Нашри осони ҳуҷҷатҳо дар порталҳои давлатӣ ё хусусӣ
Дар куҷо махсусан муҳим
Кушодани API барои таҳиягарони беруна
API-ҳои дохилӣ бо рушди фаъол
Платформаҳо бо ҳамгироии B2B ва SDK
Хизматрасониҳо бо талабот ба қоидаҳо ва тасдиқи схемаҳо
Swagger ва Redoc стандарти ҳуҷҷатҳои насли ояндаи API мебошанд. Мо тавлид, навсозӣ ва нашри ҳуҷҷатҳоро насб хоҳем кард, то ҳар як таҳиякунанда тавонад ҳамгироӣ бо API-и шуморо дар тӯли чанд дақиқа оғоз кунад.