يعد استخدام أدوات مثل Swagger إنشاء وثائق API تلقائيًا Laravel طريقة ملائمة لإنشاء وصيانة وثائق API الخاصة بك. Swagger هي أداة مفتوحة المصدر تساعدك على وصف وتوثيق واختبار واجهات برمجة التطبيقات الخاصة بك. إليك كيف يمكنك استخدامها Swagger لإنشاء Laravel وثائق API:
الخطوة 1: التثبيت Swagger لـ Laravel
استخدم الملحن لتثبيت Swagger package ملفات Laravel. شعبية package لهذا الغرض هي darkaonline/l5-swagger.
composer require "darkaonline/l5-swagger:~9.0"
الخطوة 2: تكوين Swagger
بعد التثبيت ، تحتاج إلى نشر الوثائق Swagger في public دليل التطبيق الخاص بك Laravel. يمكنك القيام بذلك عن طريق تشغيل Artisan الأوامر:
php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"
بعد ذلك ، تحتاج إلى تحرير ملف التكوين config/l5-swagger.php لتكوينه Swagger للتطبيق الخاص بك ، بما في ذلك تحديد الموقع حيث سيتم نشر الوثائق.
الخطوة 3: استخدم Annotations
تُستخدم annotations لوصف توثيق مساراتك في Laravel التطبيق الخاص بك. annotations يتم استخدامها من قبل لإنشاء Swagger وثائق API تلقائيًا. على سبيل المثال:
/**
* @OA\Get(
* path="/api/users",
* operationId="getUsersList",
* tags={"Users"},
* summary="Get list of users",
* description="Returns list of users",
* @OA\Response(
* response=200,
* description="Successful operation",
* @OA\JsonContent()
* )
*)
*/
Bước 4: Truy cập Tài liệu API Swagger
Khi bạn đã cấu hình và đặt các chú thích tương ứng، bạn có thể truy cập tài liệu API Swagger bằng cách truy cập URL tương ứng với địa chỉ mà bạn đã cấu hìhnh. Thông thường، URL này sẽ có định dạng http://your-app-url/api/documentation.
Swagger مرحبًا بك في الطريق أمامك من القصدير إلى جانب الطريق إلى دونغ تشونغ ، باو غوم كاك ثونغ س ف فون هوي كو فونغ.
Sử dụng Swagger trong Laravel giúp tạo tài liệu API tự ng và tiết kiệm thời gian trong việc tạo và duy trì tài liệu.