acepanel/panel
2
0
Fork 0
mirror of https://github.com/acepanel/panel.git synced 2026-02-04 12:40:25 +08:00
Code Issues Packages Releases Activity

feat: 更新网站文档

Browse Source
This commit is contained in:
耗子
2024-06-18 01:32:04 +08:00
parent 8bcc0c0c05
commit f4dc94ad9a
4 changed files with 206 additions and 270 deletions
Download Patch File Download Diff File Expand all files Collapse all files

266
app/http/controllers/website_controller.go
View File

@@ -33,14 +33,13 @@ func NewWebsiteController() *WebsiteController {
// List
//
// @Summary 获取网站列表
// @Description 获取网站管理的网站列表
// @Tags 网站管理
// @Produce json
// @Security BearerToken
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites [get]
// @Summary 获取网站列表
// @Tags 网站
// @Produce json
// @Security BearerToken
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites [get]
func (r *WebsiteController) List(ctx http.Context) http.Response {
var paginateRequest commonrequests.Paginate
sanitize := SanitizeRequest(ctx, &paginateRequest)
@@ -64,15 +63,14 @@ func (r *WebsiteController) List(ctx http.Context) http.Response {
// Add
//
// @Summary 添加网站
// @Description 添加网站到网站管理
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param data body requests.Add true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites [post]
// @Summary 添加网站
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param data body requests.Add true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites [post]
func (r *WebsiteController) Add(ctx http.Context) http.Response {
var addRequest requests.Add
sanitize := SanitizeRequest(ctx, &addRequest)
@@ -112,15 +110,14 @@ func (r *WebsiteController) Add(ctx http.Context) http.Response {
// Delete
//
// @Summary 删除网站
// @Description 删除网站管理的网站
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id} [delete]
// @Summary 删除网站
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id} [delete]
func (r *WebsiteController) Delete(ctx http.Context) http.Response {
var idRequest requests.ID
sanitize := SanitizeRequest(ctx, &idRequest)
@@ -142,13 +139,12 @@ func (r *WebsiteController) Delete(ctx http.Context) http.Response {
// GetDefaultConfig
//
// @Summary 获取默认配置
// @Description 获取默认首页和停止页配置
// @Tags 网站管理
// @Produce json
// @Security BearerToken
// @Success 200 {object} SuccessResponse{data=map[string]string}
// @Router /panel/website/defaultConfig [get]
// @Summary 获取默认配置
// @Tags 网站
// @Produce json
// @Security BearerToken
// @Success 200 {object} SuccessResponse{data=map[string]string}
// @Router /panel/website/defaultConfig [get]
func (r *WebsiteController) GetDefaultConfig(ctx http.Context) http.Response {
index, err := tools.Read("/www/server/openresty/html/index.html")
if err != nil {
@@ -167,15 +163,14 @@ func (r *WebsiteController) GetDefaultConfig(ctx http.Context) http.Response {
// SaveDefaultConfig
//
// @Summary 保存默认配置
// @Description 保存默认首页和停止页配置
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param data body map[string]string true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/website/defaultConfig [post]
// @Summary 保存默认配置
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param data body map[string]string true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/website/defaultConfig [post]
func (r *WebsiteController) SaveDefaultConfig(ctx http.Context) http.Response {
index := ctx.Request().Input("index")
stop := ctx.Request().Input("stop")
@@ -199,15 +194,14 @@ func (r *WebsiteController) SaveDefaultConfig(ctx http.Context) http.Response {
// GetConfig
//
// @Summary 获取配置
// @Description 获取网站的配置
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse{data=types.Website}
// @Router /panel/websites/{id}/config [get]
// @Summary 获取网站配置
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse{data=types.Website}
// @Router /panel/websites/{id}/config [get]
func (r *WebsiteController) GetConfig(ctx http.Context) http.Response {
var idRequest requests.ID
sanitize := SanitizeRequest(ctx, &idRequest)
@@ -229,16 +223,15 @@ func (r *WebsiteController) GetConfig(ctx http.Context) http.Response {
// SaveConfig
//
// @Summary 保存配置
// @Description 保存网站的配置
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Param data body requests.SaveConfig true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/config [post]
// @Summary 保存网站配置
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Param data body requests.SaveConfig true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/config [post]
func (r *WebsiteController) SaveConfig(ctx http.Context) http.Response {
var saveConfigRequest requests.SaveConfig
sanitize := SanitizeRequest(ctx, &saveConfigRequest)
@@ -256,15 +249,14 @@ func (r *WebsiteController) SaveConfig(ctx http.Context) http.Response {
// ClearLog
//
// @Summary 清空日志
// @Description 清空网站的日志
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/log [delete]
// @Summary 清空网站日志
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/log [delete]
func (r *WebsiteController) ClearLog(ctx http.Context) http.Response {
var idRequest requests.ID
sanitize := SanitizeRequest(ctx, &idRequest)
@@ -287,15 +279,14 @@ func (r *WebsiteController) ClearLog(ctx http.Context) http.Response {
// UpdateRemark
//
// @Summary 更新备注
// @Description 更新网站的备注
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/updateRemark [post]
// @Summary 更新网站备注
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/updateRemark [post]
func (r *WebsiteController) UpdateRemark(ctx http.Context) http.Response {
var idRequest requests.ID
sanitize := SanitizeRequest(ctx, &idRequest)
@@ -323,14 +314,13 @@ func (r *WebsiteController) UpdateRemark(ctx http.Context) http.Response {
// BackupList
//
// @Summary 获取备份列表
// @Description 获取网站的备份列表
// @Tags 网站管理
// @Produce json
// @Security BearerToken
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse{data=[]types.BackupFile}
// @Router /panel/website/backupList [get]
// @Summary 获取网站备份列表
// @Tags 网站
// @Produce json
// @Security BearerToken
// @Param data query commonrequests.Paginate true "request"
// @Success 200 {object} SuccessResponse{data=[]types.BackupFile}
// @Router /panel/website/backupList [get]
func (r *WebsiteController) BackupList(ctx http.Context) http.Response {
var paginateRequest commonrequests.Paginate
sanitize := SanitizeRequest(ctx, &paginateRequest)
@@ -370,15 +360,14 @@ func (r *WebsiteController) BackupList(ctx http.Context) http.Response {
// CreateBackup
//
// @Summary 创建备份
// @Description 创建网站的备份
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/createBackup [post]
// @Summary 创建网站备份
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/createBackup [post]
func (r *WebsiteController) CreateBackup(ctx http.Context) http.Response {
var idRequest requests.ID
sanitize := SanitizeRequest(ctx, &idRequest)
@@ -408,15 +397,14 @@ func (r *WebsiteController) CreateBackup(ctx http.Context) http.Response {
// UploadBackup
//
// @Summary 上传备份
// @Description 上传网站的备份
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param file formData file true "备份文件"
// @Success 200 {object} SuccessResponse
// @Router /panel/website/uploadBackup [put]
// @Summary 上传网站备份
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param file formData file true "备份文件"
// @Success 200 {object} SuccessResponse
// @Router /panel/website/uploadBackup [put]
func (r *WebsiteController) UploadBackup(ctx http.Context) http.Response {
file, err := ctx.Request().File("file")
if err != nil {
@@ -444,15 +432,14 @@ func (r *WebsiteController) UploadBackup(ctx http.Context) http.Response {
// RestoreBackup
//
// @Summary 还原备份
// @Description 还原网站的备份
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/restoreBackup [post]
// @Summary 还原网站备份
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/restoreBackup [post]
func (r *WebsiteController) RestoreBackup(ctx http.Context) http.Response {
var restoreBackupRequest requests.RestoreBackup
sanitize := SanitizeRequest(ctx, &restoreBackupRequest)
@@ -479,15 +466,14 @@ func (r *WebsiteController) RestoreBackup(ctx http.Context) http.Response {
// DeleteBackup
//
// @Summary 删除备份
// @Description 删除网站的备份
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param data body requests.DeleteBackup true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/website/deleteBackup [delete]
// @Summary 删除网站备份
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param data body requests.DeleteBackup true "request"
// @Success 200 {object} SuccessResponse
// @Router /panel/website/deleteBackup [delete]
func (r *WebsiteController) DeleteBackup(ctx http.Context) http.Response {
var deleteBackupRequest requests.DeleteBackup
sanitize := SanitizeRequest(ctx, &deleteBackupRequest)
@@ -511,15 +497,14 @@ func (r *WebsiteController) DeleteBackup(ctx http.Context) http.Response {
// ResetConfig
//
// @Summary 重置配置
// @Description 重置网站的配置
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/resetConfig [post]
// @Summary 重置网站配置
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/resetConfig [post]
func (r *WebsiteController) ResetConfig(ctx http.Context) http.Response {
var idRequest requests.ID
sanitize := SanitizeRequest(ctx, &idRequest)
@@ -615,15 +600,14 @@ server
// Status
//
// @Summary 状态
// @Description 启用或停用网站
// @Tags 网站管理
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/status [post]
// @Summary 获取网站状态
// @Tags 网站
// @Accept json
// @Produce json
// @Security BearerToken
// @Param id path int true "网站 ID"
// @Success 200 {object} SuccessResponse
// @Router /panel/websites/{id}/status [post]
func (r *WebsiteController) Status(ctx http.Context) http.Response {
var idRequest requests.ID
sanitize := SanitizeRequest(ctx, &idRequest)

70
docs/docs.go
View File

@@ -3248,14 +3248,13 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "获取网站的备份列表",
"produces": [
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取备份列表",
"summary": "获取网站备份列表",
"parameters": [
{
"type": "integer",
@@ -3300,12 +3299,11 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "获取默认首页和停止页配置",
"produces": [
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取默认配置",
"responses": {
@@ -3338,7 +3336,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "保存默认首页和停止页配置",
"consumes": [
"application/json"
],
@@ -3346,7 +3343,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "保存默认配置",
"parameters": [
@@ -3380,7 +3377,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "删除网站的备份",
"consumes": [
"application/json"
],
@@ -3388,9 +3384,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "删除备份",
"summary": "删除网站备份",
"parameters": [
{
"description": "request",
@@ -3419,7 +3415,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "上传网站的备份",
"consumes": [
"application/json"
],
@@ -3427,9 +3422,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "上传备份",
"summary": "上传网站备份",
"parameters": [
{
"type": "file",
@@ -3456,12 +3451,11 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "获取网站管理的网站列表",
"produces": [
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取网站列表",
"parameters": [
@@ -3491,7 +3485,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "添加网站到网站管理",
"consumes": [
"application/json"
],
@@ -3499,7 +3492,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "添加网站",
"parameters": [
@@ -3530,7 +3523,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "删除网站管理的网站",
"consumes": [
"application/json"
],
@@ -3538,7 +3530,7 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "删除网站",
"parameters": [
@@ -3567,7 +3559,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "获取网站的配置",
"consumes": [
"application/json"
],
@@ -3575,9 +3566,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取配置",
"summary": "获取网站配置",
"parameters": [
{
"type": "integer",
@@ -3614,7 +3605,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "保存网站的配置",
"consumes": [
"application/json"
],
@@ -3622,9 +3612,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "保存配置",
"summary": "保存网站配置",
"parameters": [
{
"type": "integer",
@@ -3660,7 +3650,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "创建网站的备份",
"consumes": [
"application/json"
],
@@ -3668,9 +3657,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "创建备份",
"summary": "创建网站备份",
"parameters": [
{
"type": "integer",
@@ -3697,7 +3686,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "清空网站的日志",
"consumes": [
"application/json"
],
@@ -3705,9 +3693,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "清空日志",
"summary": "清空网站日志",
"parameters": [
{
"type": "integer",
@@ -3734,7 +3722,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "重置网站的配置",
"consumes": [
"application/json"
],
@@ -3742,9 +3729,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "重置配置",
"summary": "重置网站配置",
"parameters": [
{
"type": "integer",
@@ -3771,7 +3758,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "还原网站的备份",
"consumes": [
"application/json"
],
@@ -3779,9 +3765,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "还原备份",
"summary": "还原网站备份",
"parameters": [
{
"type": "integer",
@@ -3808,7 +3794,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "启用或停用网站",
"consumes": [
"application/json"
],
@@ -3816,9 +3801,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "状态",
"summary": "获取网站状态",
"parameters": [
{
"type": "integer",
@@ -3845,7 +3830,6 @@ const docTemplate = `{
"BearerToken": []
}
],
"description": "更新网站的备注",
"consumes": [
"application/json"
],
@@ -3853,9 +3837,9 @@ const docTemplate = `{
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "更新备注",
"summary": "更新网站备注",
"parameters": [
{
"type": "integer",

70
docs/swagger.json
View File

@@ -3241,14 +3241,13 @@
"BearerToken": []
}
],
"description": "获取网站的备份列表",
"produces": [
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取备份列表",
"summary": "获取网站备份列表",
"parameters": [
{
"type": "integer",
@@ -3293,12 +3292,11 @@
"BearerToken": []
}
],
"description": "获取默认首页和停止页配置",
"produces": [
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取默认配置",
"responses": {
@@ -3331,7 +3329,6 @@
"BearerToken": []
}
],
"description": "保存默认首页和停止页配置",
"consumes": [
"application/json"
],
@@ -3339,7 +3336,7 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "保存默认配置",
"parameters": [
@@ -3373,7 +3370,6 @@
"BearerToken": []
}
],
"description": "删除网站的备份",
"consumes": [
"application/json"
],
@@ -3381,9 +3377,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "删除备份",
"summary": "删除网站备份",
"parameters": [
{
"description": "request",
@@ -3412,7 +3408,6 @@
"BearerToken": []
}
],
"description": "上传网站的备份",
"consumes": [
"application/json"
],
@@ -3420,9 +3415,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "上传备份",
"summary": "上传网站备份",
"parameters": [
{
"type": "file",
@@ -3449,12 +3444,11 @@
"BearerToken": []
}
],
"description": "获取网站管理的网站列表",
"produces": [
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取网站列表",
"parameters": [
@@ -3484,7 +3478,6 @@
"BearerToken": []
}
],
"description": "添加网站到网站管理",
"consumes": [
"application/json"
],
@@ -3492,7 +3485,7 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "添加网站",
"parameters": [
@@ -3523,7 +3516,6 @@
"BearerToken": []
}
],
"description": "删除网站管理的网站",
"consumes": [
"application/json"
],
@@ -3531,7 +3523,7 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "删除网站",
"parameters": [
@@ -3560,7 +3552,6 @@
"BearerToken": []
}
],
"description": "获取网站的配置",
"consumes": [
"application/json"
],
@@ -3568,9 +3559,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "获取配置",
"summary": "获取网站配置",
"parameters": [
{
"type": "integer",
@@ -3607,7 +3598,6 @@
"BearerToken": []
}
],
"description": "保存网站的配置",
"consumes": [
"application/json"
],
@@ -3615,9 +3605,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "保存配置",
"summary": "保存网站配置",
"parameters": [
{
"type": "integer",
@@ -3653,7 +3643,6 @@
"BearerToken": []
}
],
"description": "创建网站的备份",
"consumes": [
"application/json"
],
@@ -3661,9 +3650,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "创建备份",
"summary": "创建网站备份",
"parameters": [
{
"type": "integer",
@@ -3690,7 +3679,6 @@
"BearerToken": []
}
],
"description": "清空网站的日志",
"consumes": [
"application/json"
],
@@ -3698,9 +3686,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "清空日志",
"summary": "清空网站日志",
"parameters": [
{
"type": "integer",
@@ -3727,7 +3715,6 @@
"BearerToken": []
}
],
"description": "重置网站的配置",
"consumes": [
"application/json"
],
@@ -3735,9 +3722,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "重置配置",
"summary": "重置网站配置",
"parameters": [
{
"type": "integer",
@@ -3764,7 +3751,6 @@
"BearerToken": []
}
],
"description": "还原网站的备份",
"consumes": [
"application/json"
],
@@ -3772,9 +3758,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "还原备份",
"summary": "还原网站备份",
"parameters": [
{
"type": "integer",
@@ -3801,7 +3787,6 @@
"BearerToken": []
}
],
"description": "启用或停用网站",
"consumes": [
"application/json"
],
@@ -3809,9 +3794,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "状态",
"summary": "获取网站状态",
"parameters": [
{
"type": "integer",
@@ -3838,7 +3823,6 @@
"BearerToken": []
}
],
"description": "更新网站的备注",
"consumes": [
"application/json"
],
@@ -3846,9 +3830,9 @@
"application/json"
],
"tags": [
"网站管理"
"网站"
],
"summary": "更新备注",
"summary": "更新网站备注",
"parameters": [
{
"type": "integer",

70
docs/swagger.yaml
View File

@@ -2636,7 +2636,6 @@ paths:
- 用户鉴权
/panel/website/backupList:
get:
description: 获取网站的备份列表
parameters:
- in: query
name: limit
@@ -2660,12 +2659,11 @@ paths:
type: object
security:
- BearerToken: []
summary: 获取备份列表
summary: 获取网站备份列表
tags:
- 网站管理
- 网站
/panel/website/defaultConfig:
get:
description: 获取默认首页和停止页配置
produces:
- application/json
responses:
@@ -2684,11 +2682,10 @@ paths:
- BearerToken: []
summary: 获取默认配置
tags:
- 网站管理
- 网站
post:
consumes:
- application/json
description: 保存默认首页和停止页配置
parameters:
- description: request
in: body
@@ -2709,12 +2706,11 @@ paths:
- BearerToken: []
summary: 保存默认配置
tags:
- 网站管理
- 网站
/panel/website/deleteBackup:
delete:
consumes:
- application/json
description: 删除网站的备份
parameters:
- description: request
in: body
@@ -2731,14 +2727,13 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 删除备份
summary: 删除网站备份
tags:
- 网站管理
- 网站
/panel/website/uploadBackup:
put:
consumes:
- application/json
description: 上传网站的备份
parameters:
- description: 备份文件
in: formData
@@ -2754,12 +2749,11 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 上传备份
summary: 上传网站备份
tags:
- 网站管理
- 网站
/panel/websites:
get:
description: 获取网站管理的网站列表
parameters:
- in: query
name: limit
@@ -2778,11 +2772,10 @@ paths:
- BearerToken: []
summary: 获取网站列表
tags:
- 网站管理
- 网站
post:
consumes:
- application/json
description: 添加网站到网站管理
parameters:
- description: request
in: body
@@ -2801,12 +2794,11 @@ paths:
- BearerToken: []
summary: 添加网站
tags:
- 网站管理
- 网站
/panel/websites/{id}:
delete:
consumes:
- application/json
description: 删除网站管理的网站
parameters:
- description: 网站 ID
in: path
@@ -2824,12 +2816,11 @@ paths:
- BearerToken: []
summary: 删除网站
tags:
- 网站管理
- 网站
/panel/websites/{id}/config:
get:
consumes:
- application/json
description: 获取网站的配置
parameters:
- description: 网站 ID
in: path
@@ -2850,13 +2841,12 @@ paths:
type: object
security:
- BearerToken: []
summary: 获取配置
summary: 获取网站配置
tags:
- 网站管理
- 网站
post:
consumes:
- application/json
description: 保存网站的配置
parameters:
- description: 网站 ID
in: path
@@ -2878,14 +2868,13 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 保存配置
summary: 保存网站配置
tags:
- 网站管理
- 网站
/panel/websites/{id}/createBackup:
post:
consumes:
- application/json
description: 创建网站的备份
parameters:
- description: 网站 ID
in: path
@@ -2901,14 +2890,13 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 创建备份
summary: 创建网站备份
tags:
- 网站管理
- 网站
/panel/websites/{id}/log:
delete:
consumes:
- application/json
description: 清空网站的日志
parameters:
- description: 网站 ID
in: path
@@ -2924,14 +2912,13 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 清空日志
summary: 清空网站日志
tags:
- 网站管理
- 网站
/panel/websites/{id}/resetConfig:
post:
consumes:
- application/json
description: 重置网站的配置
parameters:
- description: 网站 ID
in: path
@@ -2947,14 +2934,13 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 重置配置
summary: 重置网站配置
tags:
- 网站管理
- 网站
/panel/websites/{id}/restoreBackup:
post:
consumes:
- application/json
description: 还原网站的备份
parameters:
- description: 网站 ID
in: path
@@ -2970,14 +2956,13 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 还原备份
summary: 还原网站备份
tags:
- 网站管理
- 网站
/panel/websites/{id}/status:
post:
consumes:
- application/json
description: 启用或停用网站
parameters:
- description: 网站 ID
in: path
@@ -2993,14 +2978,13 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 状态
summary: 获取网站状态
tags:
- 网站管理
- 网站
/panel/websites/{id}/updateRemark:
post:
consumes:
- application/json
description: 更新网站的备注
parameters:
- description: 网站 ID
in: path
@@ -3016,9 +3000,9 @@ paths:
$ref: '#/definitions/controllers.SuccessResponse'
security:
- BearerToken: []
summary: 更新备注
summary: 更新网站备注
tags:
- 网站管理
- 网站
/plugins/frp/config:
get:
description: 获取 Frp 配置