add scalar html

tw2066 · tw2066 · commit 57b40f6ec867 · 2025-08-19T22:10:02.000+08:00
diff --git a/README.md b/README.md
@@ -208,6 +208,7 @@ php bin/hyperf.php start
 * 访问`/swagger`可以看到swagger页面
 * 已安装[knife4j-ui](https://github.com/tw2066/knife4j-ui)，访问`/swagger/doc`可以看到knife4j页面
 * 访问`/swagger/redoc`，可以看到[redoc](https://github.com/Redocly/redoc)页面
+* 访问`/swagger/scalar`，可以看到[scalar](https://github.com/scalar/scalar)页面
 * 访问`/swagger/rapidoc`，可以看到[rapidoc](https://github.com/rapi-doc/RapiDoc)页面
 
 ## 注解
diff --git a/src/Listener/BootAppRouteListener.php b/src/Listener/BootAppRouteListener.php
@@ -4,9 +4,9 @@
 
 namespace Hyperf\ApiDocs\Listener;
 
-use Hyperf\ApiDocs\Swagger\SwaggerUiController;
 use Hyperf\ApiDocs\Swagger\SwaggerConfig;
 use Hyperf\ApiDocs\Swagger\SwaggerController;
+use Hyperf\ApiDocs\Swagger\SwaggerUiController;
 use Hyperf\Contract\ConfigInterface;
 use Hyperf\Contract\StdoutLoggerInterface;
 use Hyperf\DTO\DtoValidation;
@@ -75,6 +75,7 @@ public function process(object $event): void
             $route->get('', [SwaggerUiController::class, 'swagger']);
             $route->get('/redoc', [SwaggerUiController::class, 'redoc']);
             $route->get('/rapidoc', [SwaggerUiController::class, 'rapidoc']);
+            $route->get('/scalar', [SwaggerUiController::class, 'scalar']);
             $route->get('/doc', [SwaggerUiController::class, 'knife4j']);
             $route->get('/swagger-resources', [SwaggerUiController::class, 'swaggerResources']);
             $route->get('/webjars/{file:.*}', [SwaggerUiController::class, 'knife4jFile']);
diff --git a/src/Swagger/SwaggerUiController.php b/src/Swagger/SwaggerUiController.php
@@ -47,6 +47,14 @@ public function rapidoc(): PsrResponseInterface
         $contents = str_replace('{{$url}}', BootAppRouteListener::$httpServerName . '.' . $this->swaggerConfig->getFormat(), $contents);
         return $this->response->withAddedHeader('content-type', 'text/html')->withBody(new SwooleStream($contents));
     }
+    public function scalar(): PsrResponseInterface
+    {
+        // https://github.com/scalar/scalar
+        $filePath = $this->docsWebPath . '/scalar.html';
+        $contents = file_get_contents($filePath);
+        $contents = str_replace('{{$url}}', BootAppRouteListener::$httpServerName . '.' . $this->swaggerConfig->getFormat(), $contents);
+        return $this->response->withAddedHeader('content-type', 'text/html')->withBody(new SwooleStream($contents));
+    }
 
     public function knife4j()
     {
diff --git a/src/web/scalar.html b/src/web/scalar.html
@@ -0,0 +1,27 @@
+<!doctype html>
+<html>
+<head>
+    <title>Scalar API Reference</title>
+    <meta charset="utf-8" />
+    <meta
+            name="viewport"
+            content="width=device-width, initial-scale=1" />
+</head>
+
+<body>
+<div id="app"></div>
+
+<!-- Load the Script -->
+<script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+
+<!-- Initialize the Scalar API Reference -->
+<script>
+    Scalar.createApiReference('#app', {
+        // The URL of the OpenAPI/Swagger document
+        url: '{{$url}}',
+        // Avoid CORS issues
+        // proxyUrl: '',
+    })
+</script>
+</body>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,14 @@ public function rapidoc(): PsrResponseInterface`
`47`	`47`	`$contents = str_replace('{{$url}}', BootAppRouteListener::$httpServerName . '.' . $this->swaggerConfig->getFormat(), $contents);`
`48`	`48`	`return $this->response->withAddedHeader('content-type', 'text/html')->withBody(new SwooleStream($contents));`
`49`	`49`	`}`
	`50`	`+ public function scalar(): PsrResponseInterface`
	`51`	`+ {`
	`52`	`+ // https://github.com/scalar/scalar`
	`53`	`+ $filePath = $this->docsWebPath . '/scalar.html';`
	`54`	`+ $contents = file_get_contents($filePath);`
	`55`	`+ $contents = str_replace('{{$url}}', BootAppRouteListener::$httpServerName . '.' . $this->swaggerConfig->getFormat(), $contents);`
	`56`	`+ return $this->response->withAddedHeader('content-type', 'text/html')->withBody(new SwooleStream($contents));`
	`57`	`+ }`
`50`	`58`
`51`	`59`	`public function knife4j()`
`52`	`60`	`{`