#137: add new documentation viewer Scalar

yogyrton · yogyrton · commit 0224d9715888 · 2025-01-16T13:04:42.000+03:00
diff --git a/config/auto-doc.php b/config/auto-doc.php
@@ -121,7 +121,7 @@
     |--------------------------------------------------------------------------
     |
     | Tool for rendering API documentation in HTML format.
-    | Available values: "swagger", "elements", "rapidoc"
+    | Available values: "swagger", "elements", "rapidoc", "scalar"
     */
     'documentation_viewer' => env('SWAGGER_SPEC_VIEWER', 'swagger'),
 
diff --git a/resources/views/documentation-scalar.blade.php b/resources/views/documentation-scalar.blade.php
@@ -0,0 +1,18 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Scalar</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+</head>
+
+<body>
+<script
+        id="api-reference"
+        data-url="{{ config('auto-doc.global_prefix') }}/auto-doc/documentation"
+        data-proxy-url="https://proxy.scalar.com"></script>
+
+<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+</body>
+</html>
diff --git a/tests/AutoDocControllerTest.php b/tests/AutoDocControllerTest.php
@@ -152,6 +152,20 @@ public function testGetViewRapidocDocumentation()
         $this->assertEqualsFixture('rendered_rapidoc_documentation.html', $response->getContent());
     }
 
+    public function testGetViewScalarDocumentation()
+    {
+        config([
+            'auto-doc.display_environments' => ['testing'],
+            'auto-doc.documentation_viewer' => 'scalar',
+        ]);
+
+        $response = $this->get('/');
+
+        $response->assertOk();
+
+        $this->assertEqualsFixture('rendered_scalar_documentation.html', $response->getContent());
+    }
+
     public function testGetViewDocumentationEnvironmentDisable()
     {
         $response = $this->get('/');
diff --git a/tests/fixtures/AutoDocControllerTest/rendered_scalar_documentation.html b/tests/fixtures/AutoDocControllerTest/rendered_scalar_documentation.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Scalar</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+</head>
+
+<body>
+<script
+        id="api-reference"
+        data-url="/auto-doc/documentation"
+        data-proxy-url="https://proxy.scalar.com"></script>
+
+<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+</body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@`
`121`	`121`	`\|--------------------------------------------------------------------------`
`122`	`122`	`\|`
`123`	`123`	`\| Tool for rendering API documentation in HTML format.`
`124`		`- \| Available values: "swagger", "elements", "rapidoc"`
	`124`	`+ \| Available values: "swagger", "elements", "rapidoc", "scalar"`
`125`	`125`	`*/`
`126`	`126`	`'documentation_viewer' => env('SWAGGER_SPEC_VIEWER', 'swagger'),`
`127`	`127`