OpenAPI

OpenAPI: API loyihalash va boshqarish

OpenAPI — API uchun mashina oʻqiy oladigan shartnoma; WSO2 API Manager bilan shu shartnomadan nashr, xavfsizlik va hujjatlargacha borasiz.

Xulosa: OpenAPI (Swagger) — REST API larni bitta YAML yoki JSON faylida tavsiflovchi standart spetsifikatsiya. Hujjat, sinov va kod namunasi undan quriladi va WSO2 API Manager aynan shu faylni API ni nashr etish, xavfsizlik va hujjatlashtirish uchun ishlatadi.

Tanishuv

OpenAPI taʼrifi

OpenAPI (ilgari Swagger deb atalgan) REST API larni tavsiflash uchun standart spetsifikatsiya: yoʻllar, metodlar, kirish va chiqish, autentifikatsiya usuli va javoblar bitta faylda. Vositalar shu fayldan hujjat, kod namunasi, sinov serveri va sinovlar yaratadi.

Dizayn-birinchi (Design-first) degani avval shartnoma yoziladi, keyin kod; isteʼmolchi va ishlab chiqaruvchi jamoalar bir vaqtda ishlaydi va nomuvofiqliklar erta topiladi. OpenAPI spetsifikatsiyasining joriy versiyasi 3.1 va API Manager 4.7 uni AsyncAPI 3 bilan birga qoʻllab-quvvatlaydi.

OpenAPI shartnomasi va undan yaratilgan hujjat yonma-yon
Namuna

OpenAPI shartnomasi tuzilishi

Fayl tuzilishini koʻrish uchun variantlarni oʻzgartiring.

OpenAPI shartnomasi namunasi

Metodlar
API Manager da

Shartnomadan nashr etilgan API gacha

  1. Loyihalash: Shartnomani OpenAPI faylida (YAML yoki JSON) yozing yoki API Manager dagi sunʼiy intellekt dizayn yordamchisidan foydalaning.
  2. Koʻrib chiqish: Boshqaruv (Governance) qoidalari nomlash, xavfsizlik va versiyalashni avtomatik tekshiradi.
  3. Nashr: Faylni Publisher ga yuklang; xavfsizlik va tezlik chegarasi siyosatlarini qoʻshing va API ni nashr eting.
  4. Isteʼmol: Hujjat va sinov muhiti Developer Portal da isteʼmolchiga koʻrsatiladi.
  5. Avtomatlashtirish: apictl vositasi shu bosqichlarni CI/CD quvurida takrorlaydi.
API Manager: shlyuz, Publisher va Developer Portal

WSO2 ning rasmiy manbalari (inglizcha): WSO2 API Manager rasmiy sahifasi · API Manager hujjatlari · Manba kodi (GitHub). Imkoniyatlar versiyaga bogʻliq; qaror qilishdan oldin shu versiya hujjatlarini koʻring.

API shartnomangizni biz bilan loyihalang

API loyihalash, koʻrib chiqish va nashr etishni birga olib boramiz.