From c4a30b8e27b2a402589bea3cddce44bd9b4ba999 Mon Sep 17 00:00:00 2001 From: MadHowl Date: Fri, 20 Mar 2026 15:39:06 +1000 Subject: [PATCH] Finished php artisan spectrum:generate --format=html --- SANCTUM_SETUP_GUIDE.md | 62 ++++++++-------------------------- public/docs/index (копия).html | 26 -------------- public/docs/index.html | 27 --------------- routes/api.php | 2 +- 4 files changed, 15 insertions(+), 102 deletions(-) delete mode 100644 public/docs/index (копия).html delete mode 100644 public/docs/index.html diff --git a/SANCTUM_SETUP_GUIDE.md b/SANCTUM_SETUP_GUIDE.md index 99e988b..16092cc 100644 --- a/SANCTUM_SETUP_GUIDE.md +++ b/SANCTUM_SETUP_GUIDE.md @@ -301,7 +301,7 @@ use Illuminate\Support\Facades\Route; // Swagger Documentation - редирект на Swagger UI Route::get('/docs', function () { - return redirect()->to('/docs/index.html'); + return redirect()->to('/spectrum/openapi.html'); }); // Public routes (без авторизации) @@ -401,65 +401,31 @@ curl -X POST http://la.test/api/logout \ ### 6.2 Генерация документации -Сначала сгенерируйте OpenAPI спецификацию: +Laravel Spectrum генерирует готовый HTML с Swagger UI: ```bash -php artisan spectrum:generate +php artisan spectrum:generate --format=html ``` +Это создаёт файл `public/spectrum/openapi.html`. + ### 6.3 Настройка доступа -Для работы Swagger UI необходимо: +При генерации с флагом `--format=html` symlink создаётся автоматически. -**1. Создать символическую ссылку:** +Если symlink отсутствует, создайте его вручную: ```bash ln -sf /home/user/www/lara/storage/app/spectrum /home/user/www/lara/public/spectrum ``` -**2. Создать HTML файл Swagger UI:** - -```html - - - - - - - API Documentation - Swagger UI - - - -
- - - - -``` - ### 6.4 Файлы документации ``` public/ -└── docs/ - └── index.html # Swagger UI - -storage/ -└── app/ - └── spectrum/ - └── openapi.json # OpenAPI спецификация +└── spectrum/ + ├── openapi.html # Swagger UI (генерируется с --format=html) + └── openapi.json # OpenAPI спецификация ``` ### 6.5 Маршрут для документации @@ -469,7 +435,7 @@ storage/ // Swagger Documentation Route::get('/docs', function () { - return redirect()->to('/docs/index.html'); + return redirect()->to('/spectrum/openapi.html'); }); ``` @@ -491,8 +457,8 @@ Laravel Spectrum поставляется с готовыми командами ### 7.2 Генерация документации ```bash -# Генерация документации -php artisan spectrum:generate +# Генерация документации в формате HTML +php artisan spectrum:generate --format=html ``` **Вывод:** @@ -501,7 +467,7 @@ php artisan spectrum:generate 🔍 Analyzing routes... Found 9 API routes 📝 Generating OpenAPI specification... -✅ Documentation generated: /home/user/www/lara/storage/app/spectrum/openapi.json +✅ Documentation generated: /home/user/www/lara/public/spectrum/openapi.html ⏱️ Generation completed in 0.17 seconds 💾 Cache: 5 files, 7.04 KB ✅ Documentation generated successfully! diff --git a/public/docs/index (копия).html b/public/docs/index (копия).html deleted file mode 100644 index 5d8be59..0000000 --- a/public/docs/index (копия).html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - API Documentation - Swagger UI - - - -
- - - - diff --git a/public/docs/index.html b/public/docs/index.html deleted file mode 100644 index 93a34ad..0000000 --- a/public/docs/index.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - API Documentation - Swagger UI - - - -
- - - - - diff --git a/routes/api.php b/routes/api.php index 0469f20..86ab958 100644 --- a/routes/api.php +++ b/routes/api.php @@ -17,7 +17,7 @@ use Illuminate\Support\Facades\Route; // Swagger Documentation Route::get('/docs', function () { - return redirect()->to('/docs/index.html'); + return redirect()->to('/spectrum/openapi.html'); }); // Public routes