refactor(plugins/openapi/swagger): 删除 displayOperationId 属性

issue9 · Nov 23, 2024 · 6dfadd1 · 6dfadd1
1 parent 5c0f12d
commit 6dfadd1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/plugins/openapi/openapi.go b/plugins/openapi/openapi.go
@@ -2,5 +2,5 @@
 //
 // SPDX-License-Identifier: MIT
 
-// package openapi 提供 [github.com/isse9/web/openapi] 文档的阅读器
+// package openapi 提供 [github.com/issue9/web/openapi] 文档的阅读器
 package openapi
diff --git a/plugins/openapi/swagger/swagger.go b/plugins/openapi/swagger/swagger.go
@@ -33,11 +33,11 @@ func Install(s web.Server) {
 // 可用来代替 [openapi.WithHTML]
 //
 // assets swagger 的页面资源，可以直接引用 [OnlineAssets]，也可以指向自有的服务器；
-// favicon 图标，
+// logo 图标；
 //
 // [swagger]: https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/
-func WithHTML(assets, favicon string) openapi.Option {
-	return openapi.WithHTML("swagger", assets, favicon)
+func WithHTML(assets, logo string) openapi.Option {
+	return openapi.WithHTML("swagger", assets, logo)
 }
 
 // WithOnlineHTML 采用 [OnlineAssets] 作为参数的 [WithHTML] 版本

diff --git a/plugins/openapi/swagger/swagger.html b/plugins/openapi/swagger/swagger.html
@@ -7,7 +7,7 @@
         <title>{{.Info.Title}}</title>
 
         {{if .Info.Description}}<meta name="description" content="{{.Info.Description}}" />{{end}}
-        {{if .XFavicon}}<link rel="icon" href="{{.XFavicon}}">{{end}}
+        {{if .XLogo}}<link rel="icon" href="{{.XLogo}}">{{end}}
 
         <link rel="stylesheet" href="{{.XAssets}}/swagger-ui.css" />
     </head>
@@ -19,7 +19,6 @@
             window.ui = SwaggerUIBundle({
                 spec: {{ json . }},
                 dom_id: '#swagger-ui',
-                displayOperationId: true,
             });
         };
         </script>