pref: Improve Swagger authentication (#7298)

1Panel-dev · Dec 9, 2024 · 2bc07c9 · 2bc07c9
1 parent 3d84a55
commit 2bc07c9
Show file tree

Hide file tree

Showing 49 changed files with 3,168 additions and 14 deletions.
diff --git a/backend/app/api/v1/app.go b/backend/app/api/v1/app.go
@@ -15,6 +15,7 @@ import (
 // @Param request body request.AppSearch true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/search [post]
 func (b *BaseApi) SearchApp(c *gin.Context) {
 	var req request.AppSearch
@@ -33,6 +34,7 @@ func (b *BaseApi) SearchApp(c *gin.Context) {
 // @Summary Sync app list
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/sync [post]
 // @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"应用商店同步","formatEN":"App store synchronization"}
 func (b *BaseApi) SyncApp(c *gin.Context) {
@@ -65,6 +67,7 @@ func (b *BaseApi) SyncApp(c *gin.Context) {
 // @Param key path string true "app key"
 // @Success 200 {object} response.AppDTO
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/:key [get]
 func (b *BaseApi) GetApp(c *gin.Context) {
 	appKey, err := helper.GetStrParamByKey(c, "key")
@@ -88,6 +91,7 @@ func (b *BaseApi) GetApp(c *gin.Context) {
 // @Param version path string true "app type"
 // @Success 200 {object} response.AppDetailDTO
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/detail/:appId/:version/:type [get]
 func (b *BaseApi) GetAppDetail(c *gin.Context) {
 	appID, err := helper.GetIntParamByKey(c, "appId")
@@ -111,6 +115,7 @@ func (b *BaseApi) GetAppDetail(c *gin.Context) {
 // @Param appId path integer true "id"
 // @Success 200 {object} response.AppDetailDTO
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/details/:id [get]
 func (b *BaseApi) GetAppDetailByID(c *gin.Context) {
 	appDetailID, err := helper.GetIntParamByKey(c, "id")
@@ -131,6 +136,7 @@ func (b *BaseApi) GetAppDetailByID(c *gin.Context) {
 // @Accept json
 // @Success 200 {object} response.IgnoredApp
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/ignored [get]
 func (b *BaseApi) GetIgnoredApp(c *gin.Context) {
 	res, err := appService.GetIgnoredApp()
@@ -147,6 +153,7 @@ func (b *BaseApi) GetIgnoredApp(c *gin.Context) {
 // @Param request body request.AppInstallCreate true "request"
 // @Success 200 {object} model.AppInstall
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/install [post]
 // @x-panel-log {"bodyKeys":["name"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"安装应用 [name]","formatEN":"Install app [name]"}
 func (b *BaseApi) InstallApp(c *gin.Context) {
@@ -178,6 +185,7 @@ func (b *BaseApi) GetAppTags(c *gin.Context) {
 // @Summary Get app list update
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/checkupdate [get]
 func (b *BaseApi) GetAppListUpdate(c *gin.Context) {
 	res, err := appService.GetAppUpdate()

diff --git a/backend/app/api/v1/app_install.go b/backend/app/api/v1/app_install.go
@@ -15,6 +15,7 @@ import (
 // @Param request body request.AppInstalledSearch true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/search [post]
 func (b *BaseApi) SearchAppInstalled(c *gin.Context) {
 	var req request.AppInstalledSearch
@@ -46,6 +47,7 @@ func (b *BaseApi) SearchAppInstalled(c *gin.Context) {
 // @Accept json
 // @Success 200 array dto.AppInstallInfo
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/list [get]
 func (b *BaseApi) ListAppInstalled(c *gin.Context) {
 	list, err := appInstallService.GetInstallList()
@@ -62,6 +64,7 @@ func (b *BaseApi) ListAppInstalled(c *gin.Context) {
 // @Param request body request.AppInstalledInfo true "request"
 // @Success 200 {object} response.AppInstalledCheck
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/check [post]
 func (b *BaseApi) CheckAppInstalled(c *gin.Context) {
 	var req request.AppInstalledInfo
@@ -82,6 +85,7 @@ func (b *BaseApi) CheckAppInstalled(c *gin.Context) {
 // @Param request body dto.OperationWithNameAndType true "request"
 // @Success 200 {integer} port
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/loadport [post]
 func (b *BaseApi) LoadPort(c *gin.Context) {
 	var req dto.OperationWithNameAndType
@@ -102,6 +106,7 @@ func (b *BaseApi) LoadPort(c *gin.Context) {
 // @Param request body dto.OperationWithNameAndType true "request"
 // @Success 200 {string} response.DatabaseConn
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/conninfo/:key [get]
 func (b *BaseApi) LoadConnInfo(c *gin.Context) {
 	var req dto.OperationWithNameAndType
@@ -122,6 +127,7 @@ func (b *BaseApi) LoadConnInfo(c *gin.Context) {
 // @Param appInstallId path integer true "App install id"
 // @Success 200 {array} dto.AppResource
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/delete/check/:appInstallId [get]
 func (b *BaseApi) DeleteCheck(c *gin.Context) {
 	appInstallId, err := helper.GetIntParamByKey(c, "appInstallId")
@@ -142,6 +148,7 @@ func (b *BaseApi) DeleteCheck(c *gin.Context) {
 // @Summary Sync app installed
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/sync [post]
 // @x-panel-log {"bodyKeys":[],"paramKeys":[],"BeforeFunctions":[],"formatZH":"同步已安装应用列表","formatEN":"Sync the list of installed apps"}
 func (b *BaseApi) SyncInstalled(c *gin.Context) {
@@ -158,6 +165,7 @@ func (b *BaseApi) SyncInstalled(c *gin.Context) {
 // @Param request body request.AppInstalledOperate true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/op [post]
 // @x-panel-log {"bodyKeys":["installId","operate"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"installId","isList":false,"db":"app_installs","output_column":"app_id","output_value":"appId"},{"input_column":"id","input_value":"installId","isList":false,"db":"app_installs","output_column":"name","output_value":"appName"},{"input_column":"id","input_value":"appId","isList":false,"db":"apps","output_column":"key","output_value":"appKey"}],"formatZH":"[operate] 应用 [appKey][appName]","formatEN":"[operate] App [appKey][appName]"}
 func (b *BaseApi) OperateInstalled(c *gin.Context) {
@@ -178,6 +186,7 @@ func (b *BaseApi) OperateInstalled(c *gin.Context) {
 // @Param key path string true "request"
 // @Success 200 {array} response.AppService
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/services/:key [get]
 func (b *BaseApi) GetServices(c *gin.Context) {
 	key := c.Param("key")
@@ -195,6 +204,7 @@ func (b *BaseApi) GetServices(c *gin.Context) {
 // @Param appInstallId path integer true "request"
 // @Success 200 {array} dto.AppVersion
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/update/versions [post]
 func (b *BaseApi) GetUpdateVersions(c *gin.Context) {
 	var req request.AppUpdateVersion
@@ -215,6 +225,7 @@ func (b *BaseApi) GetUpdateVersions(c *gin.Context) {
 // @Param request body request.PortUpdate true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/port/change [post]
 // @x-panel-log {"bodyKeys":["key","name","port"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"应用端口修改 [key]-[name] => [port]","formatEN":"Application port update [key]-[name] => [port]"}
 func (b *BaseApi) ChangeAppPort(c *gin.Context) {
@@ -235,6 +246,7 @@ func (b *BaseApi) ChangeAppPort(c *gin.Context) {
 // @Param request body dto.OperationWithNameAndType true "request"
 // @Success 200 {string} content
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/conf [post]
 func (b *BaseApi) GetDefaultConfig(c *gin.Context) {
 	var req dto.OperationWithNameAndType
@@ -256,6 +268,7 @@ func (b *BaseApi) GetDefaultConfig(c *gin.Context) {
 // @Param appInstallId path string true "request"
 // @Success 200 {object} response.AppParam
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/params/:appInstallId [get]
 func (b *BaseApi) GetParams(c *gin.Context) {
 	appInstallId, err := helper.GetIntParamByKey(c, "appInstallId")
@@ -277,6 +290,7 @@ func (b *BaseApi) GetParams(c *gin.Context) {
 // @Param request body request.AppInstalledUpdate true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/params/update [post]
 // @x-panel-log {"bodyKeys":["installId"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"应用参数修改 [installId]","formatEN":"Application param update [installId]"}
 func (b *BaseApi) UpdateInstalled(c *gin.Context) {
@@ -297,6 +311,7 @@ func (b *BaseApi) UpdateInstalled(c *gin.Context) {
 // @Param request body request.AppInstalledIgnoreUpgrade true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /apps/installed/ignore [post]
 // @x-panel-log {"bodyKeys":["installId"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"忽略应用 [installId] 版本升级","formatEN":"Application param update [installId]"}
 func (b *BaseApi) IgnoreUpgrade(c *gin.Context) {

diff --git a/backend/app/api/v1/auth.go b/backend/app/api/v1/auth.go
@@ -87,6 +87,7 @@ func (b *BaseApi) MFALogin(c *gin.Context) {
 // @Summary User logout
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /auth/logout [post]
 func (b *BaseApi) LogOut(c *gin.Context) {
 	if err := authService.LogOut(c); err != nil {

diff --git a/backend/app/api/v1/backup.go b/backend/app/api/v1/backup.go
@@ -17,6 +17,7 @@ import (
 // @Param request body dto.BackupOperate true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup [post]
 // @x-panel-log {"bodyKeys":["type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"创建备份账号 [type]","formatEN":"create backup account [type]"}
 func (b *BaseApi) CreateBackup(c *gin.Context) {
@@ -52,6 +53,7 @@ func (b *BaseApi) CreateBackup(c *gin.Context) {
 // @Summary Refresh OneDrive token
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/refresh/onedrive [post]
 func (b *BaseApi) RefreshOneDriveToken(c *gin.Context) {
 	backupService.Run()
@@ -64,6 +66,7 @@ func (b *BaseApi) RefreshOneDriveToken(c *gin.Context) {
 // @Param request body dto.ForBuckets true "request"
 // @Success 200 {array} string
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/search [post]
 func (b *BaseApi) ListBuckets(c *gin.Context) {
 	var req dto.ForBuckets
@@ -100,6 +103,7 @@ func (b *BaseApi) ListBuckets(c *gin.Context) {
 // @Accept json
 // @Success 200 {object} dto.OneDriveInfo
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/onedrive [get]
 func (b *BaseApi) LoadOneDriveInfo(c *gin.Context) {
 	data, err := backupService.LoadOneDriveInfo()
@@ -116,6 +120,7 @@ func (b *BaseApi) LoadOneDriveInfo(c *gin.Context) {
 // @Param request body dto.OperateByID true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/del [post]
 // @x-panel-log {"bodyKeys":["id"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"id","isList":false,"db":"backup_accounts","output_column":"type","output_value":"types"}],"formatZH":"删除备份账号 [types]","formatEN":"delete backup account [types]"}
 func (b *BaseApi) DeleteBackup(c *gin.Context) {
@@ -137,6 +142,7 @@ func (b *BaseApi) DeleteBackup(c *gin.Context) {
 // @Param request body dto.RecordSearch true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/record/search [post]
 func (b *BaseApi) SearchBackupRecords(c *gin.Context) {
 	var req dto.RecordSearch
@@ -162,6 +168,7 @@ func (b *BaseApi) SearchBackupRecords(c *gin.Context) {
 // @Param request body dto.RecordSearchByCronjob true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/record/search/bycronjob [post]
 func (b *BaseApi) SearchBackupRecordsByCronjob(c *gin.Context) {
 	var req dto.RecordSearchByCronjob
@@ -187,6 +194,7 @@ func (b *BaseApi) SearchBackupRecordsByCronjob(c *gin.Context) {
 // @Param request body dto.DownloadRecord true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/record/download [post]
 // @x-panel-log {"bodyKeys":["source","fileName"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"下载备份记录 [source][fileName]","formatEN":"download backup records [source][fileName]"}
 func (b *BaseApi) DownloadRecord(c *gin.Context) {
@@ -209,6 +217,7 @@ func (b *BaseApi) DownloadRecord(c *gin.Context) {
 // @Param request body dto.BatchDeleteReq true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/record/del [post]
 // @x-panel-log {"bodyKeys":["ids"],"paramKeys":[],"BeforeFunctions":[{"input_column":"id","input_value":"ids","isList":true,"db":"backup_records","output_column":"file_name","output_value":"files"}],"formatZH":"删除备份记录 [files]","formatEN":"delete backup records [files]"}
 func (b *BaseApi) DeleteBackupRecord(c *gin.Context) {
@@ -230,6 +239,7 @@ func (b *BaseApi) DeleteBackupRecord(c *gin.Context) {
 // @Param request body dto.BackupOperate true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/update [post]
 // @x-panel-log {"bodyKeys":["type"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"更新备份账号 [types]","formatEN":"update backup account [types]"}
 func (b *BaseApi) UpdateBackup(c *gin.Context) {
@@ -266,6 +276,7 @@ func (b *BaseApi) UpdateBackup(c *gin.Context) {
 // @Summary List backup accounts
 // @Success 200 {array} dto.BackupInfo
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/search [get]
 func (b *BaseApi) ListBackup(c *gin.Context) {
 	data, err := backupService.List()
@@ -283,6 +294,7 @@ func (b *BaseApi) ListBackup(c *gin.Context) {
 // @Param request body dto.BackupSearchFile true "request"
 // @Success 200 {array} string
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/search/files [post]
 func (b *BaseApi) LoadFilesFromBackup(c *gin.Context) {
 	var req dto.BackupSearchFile
@@ -300,6 +312,7 @@ func (b *BaseApi) LoadFilesFromBackup(c *gin.Context) {
 // @Param request body dto.CommonBackup true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/backup [post]
 // @x-panel-log {"bodyKeys":["type","name","detailName"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"备份 [type] 数据 [name][detailName]","formatEN":"backup [type] data [name][detailName]"}
 func (b *BaseApi) Backup(c *gin.Context) {
@@ -344,6 +357,7 @@ func (b *BaseApi) Backup(c *gin.Context) {
 // @Param request body dto.CommonRecover true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/recover [post]
 // @x-panel-log {"bodyKeys":["type","name","detailName","file"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"从 [file] 恢复 [type] 数据 [name][detailName]","formatEN":"recover [type] data [name][detailName] from [file]"}
 func (b *BaseApi) Recover(c *gin.Context) {
@@ -394,6 +408,7 @@ func (b *BaseApi) Recover(c *gin.Context) {
 // @Param request body dto.CommonRecover true "request"
 // @Success 200
 // @Security ApiKeyAuth
+// @Security Timestamp
 // @Router /settings/backup/recover/byupload [post]
 // @x-panel-log {"bodyKeys":["type","name","detailName","file"],"paramKeys":[],"BeforeFunctions":[],"formatZH":"从 [file] 恢复 [type] 数据 [name][detailName]","formatEN":"recover [type] data [name][detailName] from [file]"}
 func (b *BaseApi) RecoverByUpload(c *gin.Context) {