FusionSwagger / OpenAPI
Swagger UI داخلی و مشخصات OpenAPI تولیدشده از ماژول‌های route
نمای کلی
Fusion Swagger UI و JSON OpenAPI را از ماژول‌های route ثبت‌شده mount می‌کند (قراردادی + routeهای HTTP سفارشی).
| تنظیم | پیش‌فرض |
|---|---|
swagger.enabled | true |
swagger.path | /swagger |
زیر config.swagger در fusion.<env>.json پیکربندی کنید. اسکفولد CLI در dev معمولاً Swagger را روشن و در stage / prod خاموش می‌کند. schema کامل فایل: Settings و پیکربندی.
چه چیزی مستند می‌شود
- مسیرها از
@route/route()/[Route] - verbهای قراردادی و عملیات‌های
@http_get…@http_options/httpGet…httpOptions/[HttpGet]…[HttpOptions] tags،title،desc،deprecated،version- وقتی
version="v1"تنظیم شود، مسیرها پیشوند می‌گیرند (/v1/...) و UI می‌تواند navbar نسخه نشان دهد
پیکربندی سراسری
برای بلوک کامل JSON مربوط به swagger (info، servers، auth، navbar، ui) به دستورات و محیط‌ها مراجعه کنید.
غیرفعال کردن
swagger.enabled را false کنید، یا swagger.path را خالی / false کنید.