OpenAPI: тарроҳӣ ва идоракунии API
OpenAPI шартномаест, ки мошин онро мехонад, барои API; бо WSO2 API Manager аз ҳамин шартнома то нашр, амният ва ҳуҷҷатҳо мерасед.
Хулоса: OpenAPI (Swagger) мушаххасоти стандартӣ барои тавсифи API-ҳои REST дар як файли YAML ё JSON аст. Ҳуҷҷат, озмун ва намунаи рамз аз он сохта мешавад ва WSO2 API Manager ҳамон файлро барои нашр, амният ва ҳуҷҷатгузории API истифода мекунад.
Таърифи OpenAPI
OpenAPI (ки қаблан Swagger номида буд) мушаххасоти стандартӣ барои тавсифи API-ҳои REST аст: масирҳо, методҳо, вуруд ва хуруҷ, усули тасдиқи ҳувият ва посухҳо дар як файл. Абзорҳо аз рӯи ҳамин файл ҳуҷҷат, намунаи рамз, сервери озмоишӣ ва озмун месозанд.
Тарроҳӣ-аввал (Design-first) маънои онро дорад, ки аввал шартнома навишта мешавад ва баъд рамз; дастаҳои истифодабаранда ва истеҳсолкунанда ҳамзамон кор мекунанд ва ноҳамоҳангиҳо барвақт пайдо мешаванд. Нусхаи ҷории мушаххасоти OpenAPI 3.1 аст ва API Manager 4.7 онро дар канори AsyncAPI 3 дастгирӣ мекунад.
Сохтори шартномаи OpenAPI
Барои дидани сохтори файл гузинаҳоро тағйир диҳед.
Намунаи шартномаи OpenAPI
Аз шартнома то API-и нашршуда
- Тарроҳӣ: Шартномаро дар файли OpenAPI (YAML ё JSON) нависед ё аз ёрдамчии тарроҳии ҳуши сунъӣ дар API Manager кумак гиред.
- Бознигарӣ: Қоидаҳои идоракунӣ (Governance) номгузорӣ, амният ва версиябандиро худкор месанҷанд.
- Нашр: Файлро ба Publisher ворид кунед; сиёсатҳои амният ва ҳадди суръатро илова кунед ва API-ро нашр кунед.
- Истеъмол: Ҳуҷҷатҳо ва муҳити озмоишӣ дар Developer Portal ба истифодабаранда нишон дода мешавад.
- Худкорсозӣ: Абзори apictl ҳамин марҳилаҳоро дар хати CI/CD такрор мекунад.
Манбаъҳои расмии WSO2 (ба забони англисӣ): Саҳифаи расмии WSO2 API Manager · Ҳуҷҷатҳои API Manager · Рамзи манбаъ (GitHub). Имкониятҳо ба нусха вобастаанд; пеш аз қарор ҳуҷҷатҳои ҳамон нусхаро бинед.
Шартномаи API-и худро бо мо тарроҳӣ кунед
Тарроҳӣ, бознигарӣ ва нашри APIро якҷоя пеш мебарем.