Արագ և հասկանալի API-ի համար անհրաժեշտ է կառուցվածքային կարգավորումը։ Մենք օգտագործում ենք OpenAPI-ի 3-ը։ 0 + (նախկինում Swagger), որը թույլ է տալիս նկարագրել բոլոր մեթոդները, պարամետրերը և API մոդելները միասնական ստանդարտացված ձևաչափով, CPK-ի կոդի, փորձարկման և արտահանման հնարավորությամբ։
Սա նվազեցնում է զարգացման մուտքի շեմը, արագացնում ինտեգրումը և բացառում է ինտերֆեյսի թերի կամ հնացած նկարագրությունների հետ կապված սխալները։
Ի՞ նչ է տալիս OpenAPI/Swagger
| Հնարավորություն | Առավելություններ |
|---|---|
| Ինտերակտիվ ստանդարտ | Swagger UI հնարավորություն փորձարկել API անմիջապես զննարկչի |
| MSK գեներացիան | Հաճախորդների գրադարանների ավտոմատ ստեղծումը տարբեր լեզուներով |
| Կառուցվածքը ստանդարտ | Բոլոր էնդպոինտների, հաշվարկների, պատասխանների, սխալների և հեղինակային իրավունքի նկարագրությունը |
| Մեքենայություն | API կարող եք validing, պարսել, արտահանել և միացնել CI/CD |
| Արդիականությունը | Մոսկվան ինքնաբերաբար նորարարվում է API փոխելիս |
Ինչպե՞ ս է այն իրականացվել
API-ի նկարագրությունը OpenAPI 3-ում։ 0 (.yaml կամ. json):
- Postman-հավաքածուների և MSK (CURRL, JS, PHP, Python, Java, Go)
- Հեղինակային աջակցություն 'API key, JWT, OAuth2
- Հասանելի հարցումների և հնարավոր պատասխանների տեսողական քարտեզագրում
- API թեստավորումը ուղղակի փաստաթղթերից (Swagger UI/Redoc)
Զարգացողների առավելությունները
Արագ միացում առանց կառուցվածքի ձեռքով բաժանման:
- IDE և կոդի գեներատորների աջակցություն (Swagger Codegen, OpenAPI Generae)
- Մոսկվան միշտ համապատասխանում է ներկա API
- Հարմար է դիմումատուներին և ինտեգրատորներին փոխանցելու համար
- DX (developer experience) և իրականացման արագությունը
Որտեղ հատկապես կարևոր է
Բաց կամ հանրային API նախագծեր:
- API-first մոտեցում
- Պլատֆորմները արտաքին ինտեգրումների և ավստրիական միացությունների հետ
- Բջջային և առջևի ծրագրեր, որոնք աշխատում են backend API-ի հետ
OpenAPI-ը API-ի նկարագրության ժամանակակից լեզուն է, իսկ Swagger-ը նրա հարմար ինտերֆեյսը է։ Դուք ստանում եք թափանցիկ փաստաթղթեր, արագ SDK գեներացիա և առավելագույն հարմարավետություն բոլոր նրանց համար, ովքեր միացված են ձեր համակարգին։