From 0958daa91fc2034c2b4ed5fe7df8bf58ec97b5fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gu=CC=88nther=20Debrauwer?= Date: Tue, 9 Jul 2024 16:19:27 +0200 Subject: [PATCH 1/3] Support swagger-ui's oauth2 redirect --- resources/views/index.blade.php | 1 + .../SwaggerOAuth2RedirectController.php | 13 ++++++ .../Controllers/SwaggerViewController.php | 3 +- src/SwaggerUiServiceProvider.php | 3 +- tests/SwaggerOAuth2RedirectRouteTest.php | 41 +++++++++++++++++++ 5 files changed, 59 insertions(+), 2 deletions(-) create mode 100644 src/Http/Controllers/SwaggerOAuth2RedirectController.php create mode 100644 tests/SwaggerOAuth2RedirectRouteTest.php diff --git a/resources/views/index.blade.php b/resources/views/index.blade.php index e45c629..f9291ec 100644 --- a/resources/views/index.blade.php +++ b/resources/views/index.blade.php @@ -55,6 +55,7 @@ @if (!is_null($data["validator_url"])) validatorUrl: '{{ $data["validator_url"] }}' @endif + oauth2RedirectUrl: '{{ url("{$data['path']}/oauth2-redirect") }}', }); ui.initOAuth({ diff --git a/src/Http/Controllers/SwaggerOAuth2RedirectController.php b/src/Http/Controllers/SwaggerOAuth2RedirectController.php new file mode 100644 index 0000000..5d4f089 --- /dev/null +++ b/src/Http/Controllers/SwaggerOAuth2RedirectController.php @@ -0,0 +1,13 @@ +body(); + } +} diff --git a/src/Http/Controllers/SwaggerViewController.php b/src/Http/Controllers/SwaggerViewController.php index e06c240..624212f 100644 --- a/src/Http/Controllers/SwaggerViewController.php +++ b/src/Http/Controllers/SwaggerViewController.php @@ -4,10 +4,11 @@ use Illuminate\Http\Request; use Illuminate\Support\ItemNotFoundException; +use Illuminate\View\View; class SwaggerViewController { - public function __invoke(Request $request) + public function __invoke(Request $request) : View { try { $file = collect(config('swagger-ui.files'))->filter(function ($values) use ($request) { diff --git a/src/SwaggerUiServiceProvider.php b/src/SwaggerUiServiceProvider.php index 4380269..62bc644 100644 --- a/src/SwaggerUiServiceProvider.php +++ b/src/SwaggerUiServiceProvider.php @@ -6,6 +6,7 @@ use Illuminate\Support\ServiceProvider; use NextApps\SwaggerUi\Console\InstallCommand; use NextApps\SwaggerUi\Http\Controllers\OpenApiJsonController; +use NextApps\SwaggerUi\Http\Controllers\SwaggerOAuth2RedirectController; use NextApps\SwaggerUi\Http\Controllers\SwaggerViewController; class SwaggerUiServiceProvider extends ServiceProvider @@ -40,7 +41,7 @@ protected function loadRoutes() : void Route::middleware($values['middleware']) ->group(function () use ($values) { Route::get($values['path'], SwaggerViewController::class)->name($values['path'] . '.index'); - + Route::get($values['path'] . '/oauth2-redirect', SwaggerOAuth2RedirectController::class)->name($values['path'] . '.oauth2-redirect'); Route::get($values['path'] . '/{filename}', OpenApiJsonController::class)->name($values['path'] . '.json'); }); }); diff --git a/tests/SwaggerOAuth2RedirectRouteTest.php b/tests/SwaggerOAuth2RedirectRouteTest.php new file mode 100644 index 0000000..1afa1f7 --- /dev/null +++ b/tests/SwaggerOAuth2RedirectRouteTest.php @@ -0,0 +1,41 @@ +set('swagger-ui.files.0.versions', ['v1' => __DIR__ . '/testfiles/openapi.json']); + config()->set('swagger-ui.files.0.oauth', ['client_id' => 1, 'client_secret' => 'foobar']); + + Gate::define('viewSwaggerUI', fn (?Authenticatable $user) => true); + } + + protected function getPackageProviders($app) : array + { + return [SwaggerUiServiceProvider::class]; + } + + /** @test */ + public function it_returns_swagger_ui_oauth2_redirect_html_file_content() + { + Http::fake([ + 'https://unpkg.com/swagger-ui-dist@latest/oauth2-redirect.html' => Http::response('foo'), + ]); + + $this->get('swagger/oauth2-redirect') + ->assertStatus(200) + ->assertSeeText('foo'); + + Http::assertSentCount(1); + } +} From 160cc119edd5500772828ee73d8cb558e6bf1aaf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gu=CC=88nther=20Debrauwer?= Date: Tue, 9 Jul 2024 16:29:29 +0200 Subject: [PATCH 2/3] wip --- composer.json | 1 + tests/SwaggerOAuth2RedirectRouteTest.php | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 3431b6d..b5902f5 100644 --- a/composer.json +++ b/composer.json @@ -29,6 +29,7 @@ "require-dev": { "adamwojs/php-cs-fixer-phpdoc-force-fqcn": "^2.0", "friendsofphp/php-cs-fixer": "^3.0", + "guzzlehttp/guzzle": "^7.5", "jasonmccreary/laravel-test-assertions": "^2.3", "orchestra/testbench": "^7.0|^8.0|^9.0", "phpunit/phpunit": "^9.5|^10.0", diff --git a/tests/SwaggerOAuth2RedirectRouteTest.php b/tests/SwaggerOAuth2RedirectRouteTest.php index 1afa1f7..d22eb11 100644 --- a/tests/SwaggerOAuth2RedirectRouteTest.php +++ b/tests/SwaggerOAuth2RedirectRouteTest.php @@ -5,7 +5,6 @@ use Illuminate\Contracts\Auth\Authenticatable; use Illuminate\Support\Facades\Gate; use Illuminate\Support\Facades\Http; -use NextApps\SwaggerUi\Http\Middleware\EnsureUserIsAuthorized; use NextApps\SwaggerUi\SwaggerUiServiceProvider; class SwaggerOAuth2RedirectRouteTest extends TestCase From 5af72f25866d0cfd349e9e475fd49a2677ef5ea6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gu=CC=88nther=20Debrauwer?= Date: Tue, 9 Jul 2024 16:33:43 +0200 Subject: [PATCH 3/3] Remove unused package-lock file + small blade file fix --- package-lock.json | 6 ------ resources/views/index.blade.php | 2 +- 2 files changed, 1 insertion(+), 7 deletions(-) delete mode 100644 package-lock.json diff --git a/package-lock.json b/package-lock.json deleted file mode 100644 index f2862a2..0000000 --- a/package-lock.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "name": "laravel-swagger-ui", - "lockfileVersion": 2, - "requires": true, - "packages": {} -} diff --git a/resources/views/index.blade.php b/resources/views/index.blade.php index f9291ec..7412b00 100644 --- a/resources/views/index.blade.php +++ b/resources/views/index.blade.php @@ -53,7 +53,7 @@ ], layout: 'StandaloneLayout', @if (!is_null($data["validator_url"])) - validatorUrl: '{{ $data["validator_url"] }}' + validatorUrl: '{{ $data["validator_url"] }}', @endif oauth2RedirectUrl: '{{ url("{$data['path']}/oauth2-redirect") }}', });