داکیومنت پروژه ها با swagger

  • پوریا سبحانلو
  • 2019-09-28 19:04:01
داکیومنت پروژه ها با swagger

سووگر  swagger چیه؟

سووگر یه ابزار قدرتمنده برای ساخت داکیومنت به صورت کاملا اتوماتیک که راه حل مناسبی برای نوشتن مستندات یه پروژه  Api  در اختیار شما میگزازه.

کلا سووگر یه ابزار برای  php هست اما خوب یه پکیج خوب برای  laravel دار که تو لینک پایین ادرسشو میزارم

https://github.com/DarkaOnLine/L5-Swagger

خوب این ادرس صفحه این پکیج هست که در ادامه میخوایم درباره نصبش صحبت کنیم

این نکته رو هم بگم که تموم نسخه های  laravel  رو تا نسخه ۶ که ساپورت میکنه

مطمین شوید که  composer رو سیستم شما هست اگه کامپوزر نیست از اموزش زیر  اموزش نصب کامپوزر رو بخونید

قدم اول. نصب  swagger

composer require zircote/swagger-php

با این دستور در ترمینال شروع به نصب swagger رو پروزه خودتون میکنید.

بعد مثل همه پکیج های لاراول نیاز هست که یه تغییراتی تو فایل  app.php انجام بدید

قدم دوم.  publish  کردن vendor. این کامند زیر رو تو ترمینال بعد نصب وارد کنید

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

قدم سوم:  سراغ فایل  config/app.php برید و در اخر قسمت providers  این خط کد رو اضافه کنید

L5Swagger\L5SwaggerServiceProvider::class

اگه از لاراول بالای 5.5 استفاده میکنید نیاز به این مرحله نیست ودر غیر این صورت این مرحله رو انجام بدید

به فیلا app/provider برید

خوب تا اینجا نصب کردیم swagger رو