✨ automatic swagger documentation

GautierDele · GautierDele · commit cb41a0fcd4b3 · 2023-08-23T22:12:22.000+02:00
diff --git a/config/rest.php b/config/rest.php
@@ -52,6 +52,14 @@
     */
 
     'documentation' => [
+        'routing' => [
+            'enabled' => true,
+            'domain' => null,
+            'path' => '/api-documentation',
+            'middlewares' => [
+                'web'
+            ]
+        ],
         'info' => [
             'title' => config('app.name'),
             'summary' => 'This is my projet\'s documentation',
diff --git a/resources/views/index.blade.php b/resources/views/index.blade.php
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta
+            name="description"
+            content="SwaggerUI"
+    />
+    <title>SwaggerUI</title>
+    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5.4.2/swagger-ui.css" />
+</head>
+<body>
+<div id="swagger-ui"></div>
+<script src="https://unpkg.com/swagger-ui-dist@5.4.2/swagger-ui-bundle.js" crossorigin></script>
+<script>
+    window.onload = () => {
+        window.ui = SwaggerUIBundle({
+            url: '/vendor/rest/openapi.json',
+            dom_id: '#swagger-ui',
+        });
+    };
+</script>
+</body>
+</html>
diff --git a/src/Console/Commands/DocumentationCommand.php b/src/Console/Commands/DocumentationCommand.php
@@ -37,7 +37,7 @@ public function handle()
         $openApi = (new OpenAPI)
             ->generate();
 
-        $path = $this->getPath('open-api');
+        $path = $this->getPath('openapi');
 
         $this->makeDirectory($path);
 
@@ -55,7 +55,7 @@ public function handle()
      */
     protected function getPath($name)
     {
-        return storage_path('app/documentation/'.$name.'.json');
+        return public_path('vendor/rest/'.$name.'.json');
     }
 
     protected function getStub()
diff --git a/src/Documentation/Schemas/OpenAPI.php b/src/Documentation/Schemas/OpenAPI.php
@@ -10,8 +10,6 @@
 
 class OpenAPI extends Schema
 {
-    // @TODO: generate swagger doc automatically
-
     /**
      * The version number of the OpenAPI specification
      *
diff --git a/src/Http/Controllers/DocumentationController.php b/src/Http/Controllers/DocumentationController.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Lomkit\Rest\Http\Controllers;
+
+class DocumentationController extends \Illuminate\Routing\Controller
+{
+    public function index() {
+        return view('rest::index');
+    }
+}
diff --git a/src/Http/routes.php b/src/Http/routes.php
@@ -0,0 +1,7 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+
+if (config('rest.documentation.routing.enabled')) {
+    Route::get('/', [\Lomkit\Rest\Http\Controllers\DocumentationController::class, 'index']);
+}
diff --git a/src/RestServiceProvider.php b/src/RestServiceProvider.php
@@ -2,6 +2,7 @@
 
 namespace Lomkit\Rest;
 
+use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Str;
 use Lomkit\Rest\Console\Commands\ActionCommand;
@@ -40,6 +41,38 @@ public function boot()
     {
         $this->registerCommands();
         $this->registerPublishing();
+
+        $this->registerRoutes();
+
+        $this->loadViewsFrom(
+            __DIR__.'/../resources/views', 'rest'
+        );
+    }
+
+    /**
+     * Register the package routes.
+     *
+     * @return void
+     */
+    private function registerRoutes()
+    {
+        Route::group($this->routeConfiguration(), function () {
+            $this->loadRoutesFrom(__DIR__.'/Http/routes.php');
+        });
+    }
+
+    /**
+     * Get the Telescope route group configuration array.
+     *
+     * @return array
+     */
+    private function routeConfiguration()
+    {
+        return [
+            'domain' => config('rest.documentation.routing.domain'),
+            'prefix' => config('rest.documentation.routing.path'),
+            'middleware' =>  config('rest.documentation.routing.middlewares', []),
+        ];
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function handle()`
`37`	`37`	`$openApi = (new OpenAPI)`
`38`	`38`	`->generate();`
`39`	`39`
`40`		`- $path = $this->getPath('open-api');`
	`40`	`+ $path = $this->getPath('openapi');`
`41`	`41`
`42`	`42`	`$this->makeDirectory($path);`
`43`	`43`
`@@ -55,7 +55,7 @@ public function handle()`
`55`	`55`	`*/`
`56`	`56`	`protected function getPath($name)`
`57`	`57`	`{`
`58`		`- return storage_path('app/documentation/'.$name.'.json');`
	`58`	`+ return public_path('vendor/rest/'.$name.'.json');`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`protected function getStub()`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,6 @@`
`10`	`10`
`11`	`11`	`class OpenAPI extends Schema`
`12`	`12`	`{`
`13`		`- // @TODO: generate swagger doc automatically`
`14`		`-`
`15`	`13`	`/**`
`16`	`14`	`* The version number of the OpenAPI specification`
`17`	`15`	`*`