با آموزش های لاراول جاب تیم در خدمت شما هستیم
swagger (سووگر) چیست؟ یک ابزار قدرتمند برای ساخت مستندات پروژه به صورت اتوماتیک، که طیف وسیعی از راه حل های مختلف برای ساخت مستندات یک Api را در اختیار شما قرار می دهد.
شاید برای شما هم پیش آمده باشد که در پروژه ای نیاز به نوشتن داکیومنت باشید اما نوشتین داکیومنت می تواند وقت زیادی از برنامه نویس بگیرد و نمی توان برای نوشتن داکیومنت در لاراول یا هر فریمورک دیگری استانداردی با نرم افزارهای word درست کرد!!! اصلا کار جالبی نخواهد بود اما چاره کار چیست؟
در دنیای وب ابزار زیادی برای ایجاد داکیومنت برای پروژه های مختلف مخصوصا لاراول وجود دارد swagger یکی از این ابزارها می باشد که شما می توانید با مراجعه با سایت swagger.io از این ابزار قدرتمند استفاده کنید اما چند مشکل کوچک در این جا وجود دارد که اولا swagger برای زبان php می باشد و نه برای فریمورک لاراول پس یا باید با اضافه کردن کلاس های و ui این ابزار در لاراول آشنا باشید یا از یک ابزار جایگزین که کل کار را به صورت مجتمع آماده کرده است استفاده کنید.
راهنمای نصب swagger در لاراول و منابع مختلفی برای استفاده و نصب swagger در لاراول وجود دارد که ما چند تا از این منابع رو براتون معرفی می کنیم که راهنمای کاملی از نصب این پکبج قدرتمند را ارائه داده اند:
- medium.com
یک راهنمای کامل از پایه نصب لاراول تا نصب پکیج مورد نظر و استفاده ساده از آن
- hackernoon.com
توضیحات کاملی دارد همراه با کلیدهای ترکیبی برای نصب!!!
- blog.marcoraddatz.com
یک آموزش عالی و کامل برای نصب و استفاده از swagger در لاراول
تا این قسمت ما 3 سایت برای نصب و راه اندازی پکیج مورد نظر معرفی کرده ایم اما امروزه تمام کارها به صورت اتوماتیک انجام می شود و نصب یک پکیج با این همه مراحل به نظر وقت گیر می آید و کسانی که در لاراول تخصص متوسط رو به پایین دارند نخواهند توانست از این پکیج استفاده کنند.
اما پکیج های وجود دارد که این کار را به صورت کامل انجام و به صورت منسجم شده ارائه کرده اند یک پکیج با داکیومنت کامل برای استفاده دوستان لاراول کار در پروژه های خودشون، پکیج laravel-apidoc-generator یک پکیج کامل و خوب برای شما عزیزان.
لینک داکیومنت کامل این پکیج https://beyondco.de/docs/laravel-apidoc-generator/getting-started/installation
پکبج بعدی و خیلی کاملتر لینک ذیل
https://dev.to/avsecdongol/laravel-api-documentation-with-swagger-and-passport-3ec0
منبع: جاب تیم
- ۰۰/۱۰/۰۸