تولید مستندات Swagger
این پکیج دو راه برای تولید مستندات Swagger برای API شما فراهم میکند: مبتنی بر مدل و مبتنی بر مسیر.
تولید مبتنی بر مدل
شما میتوانید با استفاده از گزینه --swagger با دستور make:module، مستندات Swagger را برای یک ماژول خاص تولید کنید.
php artisan make:module Product --api --swagger
این دستور یک فایل ProductDoc.php را در دایرکتوری app/Docs تولید میکند. این فایل شامل حاشیهنویسیهای OpenAPI برای API ماژول خواهد بود.
همچنین میتوانید فقط مستندات Swagger را برای یک ماژول با استفاده از گزینه --swagger بدون هیچ گزینه دیگری تولید کنید.
php artisan make:module Product --swagger
تولید مبتنی بر مسیر
این پکیج همچنین یک دستور make:swagger ارائه میدهد که میتواند با اسکن مسیرهای موجود لاراول شما، مستندات Swagger را تولید کند.
php artisan make:swagger
این دستور تمام مسیرهای برنامه شما را اسکن کرده و یک فایل مستندات جداگانه برای هر کنترلر تولید میکند.
فیلتر کردن مسیرها
شما میتوانید مسیرهایی را که اسکن میشوند با استفاده از گزینههای --path و --controller فیلتر کنید.
گزینه --path به شما امکان میدهد مسیرها را بر اساس یک پیشوند مسیر فیلتر کنید. به عنوان مثال، دستور زیر فقط مسیرهایی را که با api/v1 شروع میشوند، اسکن میکند:
php artisan make:swagger --path=api/v1
گزینه --controller به شما امکان میدهد مسیرها را بر اساس یک فضای نام کنترلر فیلتر کنید. به عنوان مثال، دستور زیر فقط مسیرهایی را که توسط کنترلرهای موجود در فضای نام Api مدیریت میشوند، اسکن میکند:
php artisan make:swagger --controller=Api
شما همچنین میتوانید این گزینهها را برای فیلتر کردن بیشتر مسیرها ترکیب کنید.
بازنویسی فایلها
به طور پیشفرض، دستور make:swagger فایلهای مستندات موجود را بازنویسی نمیکند. شما میتوانید از گزینه --force برای اجبار دستور به بازنویسی فایلهای موجود استفاده کنید.
php artisan make:swagger --force