fix: replace hardcoded references to openapi.yaml

knuckleswtf · Mar 4, 2024 · 8030aad · 8030aad
1 parent 3c87224
commit 8030aad
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 11 deletions.
diff --git a/routes/laravel.php b/routes/laravel.php
@@ -16,6 +16,6 @@
         })->name('scribe.postman');
 
         Route::get("$prefix.openapi", function () {
-            return response()->file(Storage::disk('local')->path('scribe/openapi.yaml'));
+            return response()->file(Storage::disk('local')->path('scribe/openapi.' . config('scribe.openapi.format')));
         })->name('scribe.openapi');
     });
diff --git a/routes/lumen.php b/routes/lumen.php
@@ -18,6 +18,6 @@
         return new JsonResponse(Storage::disk('local')->get('scribe/collection.json'), json: true);
     })->name('scribe.postman');
     $router->get("$prefix.openapi", function () {
-        return response()->file(Storage::disk('local')->path('scribe/openapi.yaml'));
+        return response()->file(Storage::disk('local')->path('scribe/openapi.' . config('scribe.openapi.format')));
     })->name('scribe.openapi');
 });
diff --git a/src/Writing/ExternalHtmlWriter.php b/src/Writing/ExternalHtmlWriter.php
@@ -33,7 +33,7 @@ public function getMetadata(): array
             $postmanCollectionUrl = "{$this->assetPathPrefix}collection.json";
         }
         if ($this->config->get('openapi.enabled', false)) {
-            $openApiSpecUrl = "{$this->assetPathPrefix}openapi.yaml";
+            $openApiSpecUrl = "{$this->assetPathPrefix}openapi." . config('scribe.openapi.format');
         }
         return [
             'title' => $this->config->get('title') ?: config('app.name', '') . ' Documentation',

diff --git a/src/Writing/HtmlWriter.php b/src/Writing/HtmlWriter.php
@@ -117,8 +117,8 @@ public function getMetadata(): array
             $postmanCollectionUrl = "{$this->assetPathPrefix}collection.json";
         }
         if ($this->config->get('openapi.enabled', false)) {
-            $links[] = "<a href=\"{$this->assetPathPrefix}openapi.yaml\">".u::trans("scribe::links.openapi")."</a>";
-            $openApiSpecUrl = "{$this->assetPathPrefix}openapi.yaml";
+            $links[] = "<a href=\"{$this->assetPathPrefix}openapi.".config('scribe.openapi.format')."\">".u::trans("scribe::links.openapi")."</a>";
+            $openApiSpecUrl = "{$this->assetPathPrefix}openapi.".config('scribe.openapi.format');
         }
 
         $auth = $this->config->get('auth');

diff --git a/src/Writing/Writer.php b/src/Writing/Writer.php
@@ -186,8 +186,8 @@ protected function performFinalTasksForLaravelType(): void
         $contents = preg_replace('#href="\.\./docs/css/(.+?)"#', 'href="{{ asset("' . $this->laravelAssetsPath . '/css/$1") }}"', $contents);
         $contents = preg_replace('#src="\.\./docs/(js|images)/(.+?)"#', 'src="{{ asset("' . $this->laravelAssetsPath . '/$1/$2") }}"', $contents);
         $contents = str_replace('href="../docs/collection.json"', 'href="{{ route("' . $this->paths->outputPath('postman', '.') . '") }}"', $contents);
-        $contents = str_replace('href="../docs/openapi.yaml"', 'href="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents);
-        $contents = str_replace('url="../docs/openapi.yaml"', 'url="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents);
+        $contents = str_replace('href="../docs/openapi.' . config('scribe.openapi.format') . '"', 'href="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents);
+        $contents = str_replace('url="../docs/openapi.' . config('scribe.openapi.format') . '"', 'url="{{ route("' . $this->paths->outputPath('openapi', '.') . '") }}"', $contents);
 
         file_put_contents("$this->laravelTypeOutputPath/index.blade.php", $contents);
     }

diff --git a/tests/GenerateDocumentation/BehavioursTest.php b/tests/GenerateDocumentation/BehavioursTest.php
@@ -118,7 +118,7 @@ public function calls_afterGenerating_hook()
             'html' => realpath('public/docs/index.html'),
             'blade' => null,
             'postman' => realpath('public/docs/collection.json') ?: null,
-            'openapi' => realpath('public/docs/openapi.yaml') ?: null,
+            'openapi' => realpath('public/docs/openapi.'.config('scribe.openapi.format')) ?: null,
             'assets' => [
                 'js' => realpath('public/docs/js'),
                 'css' => realpath('public/docs/css'),

diff --git a/tests/GenerateDocumentation/OutputTest.php b/tests/GenerateDocumentation/OutputTest.php
@@ -203,7 +203,7 @@ public function generated_postman_collection_file_is_correct()
     }
 
     /** @test */
-    public function generated_openapi_spec_file_is_correct()
+    public function generated_openapi_spec_file_is_correct_yaml()
     {
         RouteFacade::post('/api/withBodyParametersAsArray', [TestController::class, 'withBodyParametersAsArray']);
         RouteFacade::post('/api/withFormDataParams', [TestController::class, 'withFormDataParams']);
@@ -232,6 +232,37 @@ public function generated_openapi_spec_file_is_correct()
         $this->assertEquals($fixtureSpec, $generatedSpec);
     }
 
+    /** @test */
+    public function generated_openapi_spec_file_is_correct_json()
+    {
+        RouteFacade::post('/api/withBodyParametersAsArray', [TestController::class, 'withBodyParametersAsArray']);
+        RouteFacade::post('/api/withFormDataParams', [TestController::class, 'withFormDataParams']);
+        RouteFacade::get('/api/withResponseTag', [TestController::class, 'withResponseTag']);
+        RouteFacade::get('/api/withQueryParameters', [TestController::class, 'withQueryParameters']);
+        RouteFacade::get('/api/withAuthTag', [TestController::class, 'withAuthenticatedTag']);
+        RouteFacade::get('/api/echoesUrlParameters/{param}/{param2}/{param3?}/{param4?}', [TestController::class, 'echoesUrlParameters']);
+
+        $this->setConfig([
+            'openapi.enabled' => true,
+            'openapi.format' => 'json',
+            'openapi.overrides' => [
+                'info.version' => '3.9.9',
+            ],
+            'routes.0.apply.headers' => [
+                'Custom-Header' => 'NotSoCustom',
+            ],
+        ]);
+
+        $this->generateAndExpectConsoleOutput(
+            "Wrote HTML docs and assets to: public/docs/",
+            "Wrote OpenAPI specification to: public/docs/openapi.json"
+        );
+
+        $generatedSpec = json_decode(file_get_contents($this->openapiOutputPath(extension: 'json')), associative: true);
+        $fixtureSpec = Yaml::parseFile(__DIR__ . '/../Fixtures/openapi.yaml');
+        $this->assertEquals($fixtureSpec, $generatedSpec);
+    }
+
     /** @test */
     public function can_append_custom_http_headers()
     {
@@ -623,10 +654,12 @@ protected function postmanOutputPath(bool $laravelType = false): string
             ? Storage::disk('local')->path('scribe/collection.json') : 'public/docs/collection.json';
     }
 
-    protected function openapiOutputPath(bool $laravelType = false): string
+    protected function openapiOutputPath(bool $laravelType = false, string $extension = 'yaml'): string
     {
+        $filename = "openapi.{$extension}";
+
         return $laravelType
-            ? Storage::disk('local')->path('scribe/openapi.yaml') : 'public/docs/openapi.yaml';
+            ? Storage::disk('local')->path("scribe/$filename") : ("public/docs/$filename");
     }
 
     protected function htmlOutputPath(): string