Email: info@developit.ir

مستند سازی خودکار و ایجاد یک محیط تعاملی برای Web API با استفاده از swagger

swagger اجازه میده یک ساختار توصیفی از API خودتون بسازید. چرا مفید، عالی و کاربردی به نظر میرسه؟ چون میتونیم به طور خودکار برای API خودمون مستندات زیبا و یک محیط تعاملی ایجاد کنیم، همچنین امکان تست API رو هم برامون فراهم میکنه. swagger این کارُ با خواندن به اصطلاح حاشیه ها/یادداشت ها یا کامنت های داخل سورس انجام میده.

    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\JsonResponse
     *
     * @SWG\Get(
     *     path="/api/dashboard",
     *     description="Returns dashboard overview.",
     *     operationId="api.dashboard.index",
     *     produces={"application/json"},
     *     tags={"dashboard"},
     *     @SWG\Response(
     *         response=200,
     *         description="Dashboard overview."
     *     ),
     *     @SWG\Response(
     *         response=401,
     *         description="Unauthorized action.",
     *     )
     * )
     */
    public function index()
    {
        ...
    }
...

در پروژه های گروهی نیاز به این ابزار بیشتر احساس میشه. فرض کنید شما و همکارانتون در حال توسعه پروژه هستید. علاوه بر امکان سهولت تست API، به طور موازی شخص دیگری هم میتونه کار دیگه ای مثل تولید رابط کاربری، تهیه نسخه اندروید و ... رو انجام بده بدون نیاز به اینکه منتظر دریافت مستندات پس از آماده شدن API توسط شما باشه.

swagger

 

این مطلب آخرین بار در تاریخ 15:42 - 1396/03/19 ویرایش شده است.

ارسال نظر
1 نظر
یوشا در تاریخ 10:26 - 1396/03/25 نوشته:
اینارو از کجا پیدا می کنی o:
پاسخ مدیر:

کافیه مثل من تنبل باشی :D به دنبال هر چیزی میگردی تا کارتُ آسونتر و سریعتر کنی :P


عضویت در خبرنامه
جهت اطلاع از آخرین فعالیت های من لطفا در خبرنامه عضو شوید