مستندات کیفیت برای ایجاد API ها برای درک، پیاده سازی و نگهداری آسان مهم است. ما تولید خودکار مستندات را بر اساس مشخصات OpenAPI با استفاده از Swagger UI و Redoc، دو مورد از محبوب ترین ابزارهای تجسم API، تنظیم کردیم.
این اجازه می دهد تا شما را به ارائه توسعه دهندگان با یک رابط تعاملی که در آن شما می توانید ساختار روش ها، پرس و جو تست، و به سرعت به API خود را یاد بگیرند.
آنچه در مستندات موجود است
| بخش ها | توضیحات محصول |
|---|---|
| نقاط پایانی و روش ها | لیست کامل مسیرها، روش های HTTP، پارامترها، هدر ها |
| نمونه درخواست ها/پاسخ ها | اسکریپت برای حلقه، پستچی، جاوا اسکریپت، پایتون و زبان های دیگر |
| مجوز گرفتن | پشتیبانی از JWT، OAuth2، API کلید به طور مستقیم از رابط |
| نمودار تسهیلات | شرح مدل ها، ساختارهای تو در تو، و داده های مورد نیاز |
| کدهای خطا | تمام حالات ممکن با توضیحات |
ابزارهایی که استفاده میکنیم
Swagger UI - مستندات تعاملی در مرورگر، با توانایی تست
Redoc یک رابط قابل خواندن و استاتیک ایده آل برای انتشار در سایت است
OpenAPI 3. 0/3. 1-The فرمت BOM که همه چیز بر اساس آن است
تولید خودکار از کد - حاشیه نویسی، توضیحات، نسخه ها و به روز رسانی اسناد به صورت خودکار
صادرات به JSON/YAML/HTML
مزایای تیم و شرکا
سرعت بخشیدن به توسعه دهندگان جدید
کاهش خطاهای ادغام
همیشه به روز, مستندات کد هماهنگ
شروع سریع به ادغام بدون پشتیبانی فنی
انتشار آسان مستندات در پورتال های عمومی یا خصوصی
جایی که بسیار مهم است
API های باز برای توسعه دهندگان خارجی
API های داخلی با توسعه فعال
بستر های نرم افزاری با ادغام B2B و SDK ها
خدمات با الزامات مقررات و اعتبار سنجی طرح ها
Swagger و Redoc نسل بعدی استاندارد مستندات API هستند. ما نسل، به روز رسانی و انتشار اسناد را تنظیم خواهیم کرد تا هر توسعه دهنده بتواند در عرض چند دقیقه با API شما ادغام شود.