fix(swagger): restore apikey security definition with Bearer usage description

This commit is contained in:
2025-12-25 11:32:55 +08:00
parent c8fced4cf1
commit b566eb8058
4 changed files with 52 additions and 7 deletions

View File

@@ -46,11 +46,15 @@ import (
// @host localhost:8080 // @host localhost:8080
// @BasePath / // @BasePath /
// @securityDefinitions.bearer AdminAuth // @securityDefinitions.apikey AdminAuth
// @description Admin token for management API access // @in header
// @name Authorization
// @description Type "Bearer" followed by a space and the admin token. Example: Bearer admin123
// @securityDefinitions.bearer MasterAuth // @securityDefinitions.apikey MasterAuth
// @description Master key for tenant API access // @in header
// @name Authorization
// @description Type "Bearer" followed by a space and the master key. Example: Bearer sk-xxx
func fatal(logger *slog.Logger, msg string, args ...any) { func fatal(logger *slog.Logger, msg string, args ...any) {
logger.Error(msg, args...) logger.Error(msg, args...)

View File

@@ -4714,6 +4714,20 @@ const docTemplate = `{
} }
} }
} }
},
"securityDefinitions": {
"AdminAuth": {
"description": "Type \"Bearer\" followed by a space and the admin token. Example: Bearer admin123",
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"MasterAuth": {
"description": "Type \"Bearer\" followed by a space and the master key. Example: Bearer sk-xxx",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
} }
}` }`
@@ -4724,7 +4738,7 @@ var SwaggerInfo = &swag.Spec{
BasePath: "/", BasePath: "/",
Schemes: []string{}, Schemes: []string{},
Title: "EZ-API Control Plane", Title: "EZ-API Control Plane",
Description: "Master key for tenant API access", Description: "Management API for EZ-API Gateway system.",
InfoInstanceName: "swagger", InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate, SwaggerTemplate: docTemplate,
LeftDelim: "{{", LeftDelim: "{{",

View File

@@ -1,7 +1,7 @@
{ {
"swagger": "2.0", "swagger": "2.0",
"info": { "info": {
"description": "Master key for tenant API access", "description": "Management API for EZ-API Gateway system.",
"title": "EZ-API Control Plane", "title": "EZ-API Control Plane",
"termsOfService": "http://swagger.io/terms/", "termsOfService": "http://swagger.io/terms/",
"contact": { "contact": {
@@ -4708,5 +4708,19 @@
} }
} }
} }
},
"securityDefinitions": {
"AdminAuth": {
"description": "Type \"Bearer\" followed by a space and the admin token. Example: Bearer admin123",
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"MasterAuth": {
"description": "Type \"Bearer\" followed by a space and the master key. Example: Bearer sk-xxx",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
} }
} }

View File

@@ -798,7 +798,7 @@ info:
email: support@swagger.io email: support@swagger.io
name: API Support name: API Support
url: http://www.swagger.io/support url: http://www.swagger.io/support
description: Master key for tenant API access description: Management API for EZ-API Gateway system.
license: license:
name: Apache 2.0 name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html url: http://www.apache.org/licenses/LICENSE-2.0.html
@@ -3025,4 +3025,17 @@ paths:
summary: Update child key summary: Update child key
tags: tags:
- master - master
securityDefinitions:
AdminAuth:
description: 'Type "Bearer" followed by a space and the admin token. Example:
Bearer admin123'
in: header
name: Authorization
type: apiKey
MasterAuth:
description: 'Type "Bearer" followed by a space and the master key. Example: Bearer
sk-xxx'
in: header
name: Authorization
type: apiKey
swagger: "2.0" swagger: "2.0"