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 ۳.۱ است و API Manager ۴.۷ آن را در کنار AsyncAPI ۳ پشتیبانی می‌کند.
ساختار یک قرارداد 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 را با هم پیش ببریم.