Download the PHP package hawasly/laravel-apidog without Composer
On this page you can find all versions of the php package hawasly/laravel-apidog. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hawasly/laravel-apidog
More information about hawasly/laravel-apidog
Files in hawasly/laravel-apidog
Package laravel-apidog
Short Description Zero-config OpenAPI and Postman generator for Laravel, grouped by audience: endpoints, auth, request bodies and response examples for every case, derived from your routes and form requests.
License MIT
Homepage https://github.com/mdshwin555/laravel-apidog
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-apidog
Laravel Apidog
يولّد OpenAPI 3.1 وPostman collection من راوتات مشروع Laravel — بلا أي إعداد.
كل شيء يُشتق من الكود نفسه: الراوتات، الـFormRequests، الـmiddleware. فلا يمكن أن يتقادم عن المشروع.
الاستخدام
انتهى. لا ملف إعداد، ولا vendor:publish، ولا تعديل على شيء.
التقسيم: الجمهور أولاً
المجلدات مقسّمة حسب من يستخدم النقطة، لأنه السؤال الذي يطرحه المطوّر فعلاً — مطوّر التطبيق يريد نقاط الطالب ولا يريد نقاط الإدارة أبداً.
وداخل كل جمهور، مجلد لكل موضوع:
الأفعال ليست مجلدات: index وstore وupdate تقع كلها في مجلد موضوعها الواحد، لا في ثلاثة.
التقسيم يُقرأ من اسم الراوت ثم من المسار، ويُضبط في config/api-spec.php إن اختلفت تسمياتكم.
أمثلة لكل حالة
لكل نقطة مثال مكتمل عن كل ردّ يمكن أن تعيده — لا النجاح وحده. مواصفة تحمل 200 فقط لا تعلّم شيئاً عن الفشل، والعميل المكتوب عليها لن يعالج 422 حتى يقابلها في الإنتاج.
| الرمز | متى يُضاف | مثال |
|---|---|---|
| 200 / 201 | دائماً | سجل كامل، أو صفحة نتائج مع meta |
| 422 | حين للنقطة body | بأسماء الحقول الحقيقية ورسائلها |
| 401 | حين تحتاج توكناً | |
| 403 | حين لها صلاحية | باسم الصلاحية |
| 404 | حين لها معامل مسار | |
| 429 | حين لها حدّ معدّل | بالحدّ نفسه |
| 500 | دائماً | بالشكل الذي لا يسرّب تفصيلاً داخلياً |
| 400 | حين تُبنى الاستعلامات بـ spatie/laravel-query-builder | بترتيب أو فلتر غير مسموح |
كل مثال مبنيّ من حقول النقطة نفسها، فيبدو كهذا المورد لا كقالب عام.
ما يُشتق تلقائياً
| المصدر | |
|---|---|
| الطريقة والمسار والاسم | Route::getRoutes() |
| الجمهور والمجلد | اسم الراوت والـmiddleware |
| هل تحتاج توكناً | auth: |
| الصلاحية | permission:manage_students |
| حدّ المعدّل | throttle:10,1 |
| حقول الـbody | FormRequest::rules() و $request->validate([...]) |
| مطلوب / اختياري | required · required_if · required_with |
| الأنواع | integer · numeric · boolean · date · email · file |
| المفاتيح الأجنبية | exists: و*_id ← integer لا string |
| القيم المسموحة | in:a,b و Rule::in([...]) |
| الحدود | max:200 ← maxLength · min:1 ← minimum |
| رفع الملفات | file ← multipart/form-data |
الأمثلة مشتقّة لا مكتوبة
قيمة كل حقل تُبنى من قواعده هو: min:8 تُنتج نصاً بثمانية أحرف، in:... تُنتج أول قيمة مسموحة، url تُنتج رابطاً، confirmed تُنتج كلمة مرور.
لا جدول بأسماء حقول جاهزة — جدول كهذا يناسب المشروع الذي كُتب له وحده، وهذا يعمل على أي مشروع.
للتجاوز عند الحاجة:
Postman: يُشغَّل لا يُستورد فقط
الكولكشن يحمل ما لا تستطيع OpenAPI التعبير عنه:
١. التوكن يُحفظ تلقائياً. سكربت تسجيل الدخول يبحث عن التوكن في الرد — access_token، token، jwt، bearer، مهما كان تداخله. يعمل مع JWT وSanctum وPassport بلا إعداد.
٢. لا لصق للتوكن. الـbearer معرَّف مرة على الكولكشن وكل طلب يرثه. والنقاط العامة noauth صراحة.
٣. المعرّفات تُلتقط. كل طلب إنشاء يحفظ الـid الراجع، فـGET /categories/{{category_id}} بعده يعمل وحده. الكولكشن يُشغَّل من أوله لآخره بضغطة واحدة.
٤. أمثلة الردود محفوظة — كل الحالات، جاهزة للقراءة بلا إرسال.
مثال من مشروع حقيقي
ملف السكيما
يُكتب مع كل توليد، بلا أمر إضافي: project.schemas.json بصيغة JSON Schema
2020-12، يحمل شكل الغلاف والخطأ والتحقق، ومخططاً لكل نقطة تستقبل body.
مشتق من مستند الـOpenAPI نفسه لا مبنيّ من جديد، فلا يمكن أن يصف النقطة نفسها بشكلين. يُقرأ مباشرةً من مولّدات العملاء وأدوات التحقق دون الحاجة إلى المواصفة كاملة.
الشروحات (اختياري)
يكتب docs/api-descriptions.php بمفاتيح فارغة:
املأه مرة واحدة، وكل توليد بعدها يدمجه. الملف يبقى، والمواصفة تُعاد توليدها.
الأوامر
الإعداد (نادراً ما يلزم)
قواعد
- لا تعدّل المخرَج يدوياً — يضيع في التوليد التالي. التعديل يذهب إلى ملف الشروحات أو الإعداد.
- صدّر بيئة Postman بلا قيم عند مشاركتها. التوكن سرّ.
المتطلبات
PHP 8.1+ · Laravel 10 / 11 / 12 / 13
الترخيص
MIT
All versions of laravel-apidog with dependencies
illuminate/support Version ^10.0|^11.0|^12.0|^13.0
illuminate/console Version ^10.0|^11.0|^12.0|^13.0
illuminate/routing Version ^10.0|^11.0|^12.0|^13.0