文件模板注释 @accept 保持规范

flipped-aurora · Dec 20, 2024 · 05fd7c7 · 05fd7c7
1 parent 81b8162
commit 05fd7c7
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 41 deletions.
diff --git a/server/resource/function/api.go.tpl b/server/resource/function/api.go.tpl
@@ -2,7 +2,7 @@
 // {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
 // @Summary {{.FuncDesc}}
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=object,msg=string} "获取成功"
 // @Router /{{.Abbreviation}}/{{.Router}} [{{.Method}}]
@@ -22,7 +22,7 @@ func (a *{{.Abbreviation}}) {{.FuncName}}(c *gin.Context) {
 // {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
 // @Summary {{.FuncDesc}}
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query {{.Package}}Req.{{.StructName}}Search true "成功"
 // @Success 200 {object} response.Response{data=object,msg=string} "成功"
@@ -37,4 +37,4 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api){{.FuncName}}(c *gin.Context) {
    	}
    	response.OkWithData("返回数据",c)
 }
-{{end}}
+{{end}}
diff --git a/server/resource/function/api.js.tpl b/server/resource/function/api.js.tpl
@@ -2,7 +2,7 @@
 // {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
 // @Summary {{.FuncDesc}}
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=object,msg=string} "获取成功"
 // @Router /{{.Abbreviation}}/{{.Router}} [{{.Method}}]
@@ -18,7 +18,7 @@ export const {{.Router}} = () => {
 // {{.FuncName}} {{.FuncDesc}}
 // @Tags {{.StructName}}
 // @Summary {{.FuncDesc}}
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=object,msg=string} "成功"
 // @Router /{{.Abbreviation}}/{{.Router}} [{{.Method}}]
@@ -29,4 +29,4 @@ export const {{.Router}} = () => {
   })
 }
 
-{{- end -}}
+{{- end -}}
diff --git a/server/resource/package/server/api/api.go.tpl b/server/resource/package/server/api/api.go.tpl
@@ -27,7 +27,7 @@ type {{.StructName}}Api struct {}
 // @Tags {{.StructName}}
 // @Summary 创建{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body {{.Package}}.{{.StructName}} true "创建{{.Description}}"
 // @Success 200 {object} response.Response{msg=string} "创建成功"
@@ -55,7 +55,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Create{{.StructName}}(c *gin.Con
 // @Tags {{.StructName}}
 // @Summary 删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body {{.Package}}.{{.StructName}} true "删除{{.Description}}"
 // @Success 200 {object} response.Response{msg=string} "删除成功"
@@ -78,7 +78,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Delete{{.StructName}}(c *gin.Con
 // @Tags {{.StructName}}
 // @Summary 批量删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{msg=string} "批量删除成功"
 // @Router /{{.Abbreviation}}/delete{{.StructName}}ByIds [delete]
@@ -100,7 +100,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Delete{{.StructName}}ByIds(c *gi
 // @Tags {{.StructName}}
 // @Summary 更新{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body {{.Package}}.{{.StructName}} true "更新{{.Description}}"
 // @Success 200 {object} response.Response{msg=string} "更新成功"
@@ -128,7 +128,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Update{{.StructName}}(c *gin.Con
 // @Tags {{.StructName}}
 // @Summary 用id查询{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query {{.Package}}.{{.StructName}} true "用id查询{{.Description}}"
 // @Success 200 {object} response.Response{data={{.Package}}.{{.StructName}},msg=string} "查询成功"
@@ -149,7 +149,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Find{{.StructName}}(c *gin.Conte
 // @Tags {{.StructName}}
 // @Summary 分页获取{{.Description}}列表
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=response.PageResult,msg=string} "获取成功"
 // @Router /{{.Abbreviation}}/get{{.StructName}}List [get]
@@ -167,7 +167,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Get{{.StructName}}List(c *gin.Co
 // @Tags {{.StructName}}
 // @Summary 分页获取{{.Description}}列表
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query {{.Package}}Req.{{.StructName}}Search true "分页获取{{.Description}}列表"
 // @Success 200 {object} response.Response{data=response.PageResult,msg=string} "获取成功"
@@ -198,7 +198,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Get{{.StructName}}List(c *gin.Co
 // Get{{.StructName}}DataSource 获取{{.StructName}}的数据源
 // @Tags {{.StructName}}
 // @Summary 获取{{.StructName}}的数据源
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=object,msg=string} "查询成功"
 // @Router /{{.Abbreviation}}/get{{.StructName}}DataSource [get]
@@ -219,7 +219,7 @@ func ({{.Abbreviation}}Api *{{.StructName}}Api) Get{{.StructName}}DataSource(c *
 // Get{{.StructName}}Public 不需要鉴权的{{.Description}}接口
 // @Tags {{.StructName}}
 // @Summary 不需要鉴权的{{.Description}}接口
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=object,msg=string} "获取成功"
 // @Router /{{.Abbreviation}}/get{{.StructName}}Public [get]

diff --git a/server/resource/package/web/api/api.js.tpl b/server/resource/package/web/api/api.js.tpl
@@ -4,7 +4,7 @@ import service from '@/utils/request'
 // @Tags {{.StructName}}
 // @Summary 创建{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "创建{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"创建成功"}"
@@ -20,7 +20,7 @@ export const create{{.StructName}} = (data) => {
 // @Tags {{.StructName}}
 // @Summary 删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "删除{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}"
@@ -36,7 +36,7 @@ export const delete{{.StructName}} = (params) => {
 // @Tags {{.StructName}}
 // @Summary 批量删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body request.IdsReq true "批量删除{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}"
@@ -52,7 +52,7 @@ export const delete{{.StructName}}ByIds = (params) => {
 // @Tags {{.StructName}}
 // @Summary 更新{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "更新{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"更新成功"}"
@@ -68,7 +68,7 @@ export const update{{.StructName}} = (data) => {
 // @Tags {{.StructName}}
 // @Summary 用id查询{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query model.{{.StructName}} true "用id查询{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}"
@@ -84,7 +84,7 @@ export const find{{.StructName}} = (params) => {
 // @Tags {{.StructName}}
 // @Summary 分页获取{{.Description}}列表
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query request.PageInfo true "分页获取{{.Description}}列表"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}"
@@ -101,7 +101,7 @@ export const get{{.StructName}}List = (params) => {
 // @Tags {{.StructName}}
 // @Summary 获取数据源
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}"
 // @Router /{{.Abbreviation}}/find{{.StructName}}DataSource [get]
@@ -117,7 +117,7 @@ export const get{{.StructName}}DataSource = () => {
 
 // @Tags {{.StructName}}
 // @Summary 不需要鉴权的{{.Description}}接口
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query {{.Package}}Req.{{.StructName}}Search true "分页获取{{.Description}}列表"
 // @Success 200 {object} response.Response{data=object,msg=string} "获取成功"

diff --git a/server/resource/plugin/server/api/api.go.template b/server/resource/plugin/server/api/api.go.template
@@ -27,7 +27,7 @@ type {{.Abbreviation}} struct {}
 // @Tags {{.StructName}}
 // @Summary 创建{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "创建{{.Description}}"
 // @Success 200 {object} response.Response{msg=string} "创建成功"
@@ -55,7 +55,7 @@ func (a *{{.Abbreviation}}) Create{{.StructName}}(c *gin.Context) {
 // @Tags {{.StructName}}
 // @Summary 删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "删除{{.Description}}"
 // @Success 200 {object} response.Response{msg=string} "删除成功"
@@ -78,7 +78,7 @@ func (a *{{.Abbreviation}}) Delete{{.StructName}}(c *gin.Context) {
 // @Tags {{.StructName}}
 // @Summary 批量删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{msg=string} "批量删除成功"
 // @Router /{{.Abbreviation}}/delete{{.StructName}}ByIds [delete]
@@ -100,7 +100,7 @@ func (a *{{.Abbreviation}}) Delete{{.StructName}}ByIds(c *gin.Context) {
 // @Tags {{.StructName}}
 // @Summary 更新{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "更新{{.Description}}"
 // @Success 200 {object} response.Response{msg=string} "更新成功"
@@ -128,7 +128,7 @@ func (a *{{.Abbreviation}}) Update{{.StructName}}(c *gin.Context) {
 // @Tags {{.StructName}}
 // @Summary 用id查询{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query model.{{.StructName}} true "用id查询{{.Description}}"
 // @Success 200 {object} response.Response{data=model.{{.StructName}},msg=string} "查询成功"
@@ -149,7 +149,7 @@ func (a *{{.Abbreviation}}) Find{{.StructName}}(c *gin.Context) {
 // @Tags {{.StructName}}
 // @Summary 分页获取{{.Description}}列表
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=response.PageResult,msg=string} "获取成功"
 // @Router /{{.Abbreviation}}/get{{.StructName}}List [get]
@@ -167,7 +167,7 @@ func (a *{{.Abbreviation}}) Get{{.StructName}}List(c *gin.Context) {
 // @Tags {{.StructName}}
 // @Summary 分页获取{{.Description}}列表
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query request.{{.StructName}}Search true "分页获取{{.Description}}列表"
 // @Success 200 {object} response.Response{data=response.PageResult,msg=string} "获取成功"
@@ -198,7 +198,7 @@ func (a *{{.Abbreviation}}) Get{{.StructName}}List(c *gin.Context) {
 // Get{{.StructName}}DataSource 获取{{.StructName}}的数据源
 // @Tags {{.StructName}}
 // @Summary 获取{{.StructName}}的数据源
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=object,msg=string} "查询成功"
 // @Router /{{.Abbreviation}}/get{{.StructName}}DataSource [get]
@@ -217,7 +217,7 @@ func (a *{{.Abbreviation}}) Get{{.StructName}}DataSource(c *gin.Context) {
 // Get{{.StructName}}Public 不需要鉴权的{{.Description}}接口
 // @Tags {{.StructName}}
 // @Summary 不需要鉴权的{{.Description}}接口
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {object} response.Response{data=object,msg=string} "获取成功"
 // @Router /{{.Abbreviation}}/get{{.StructName}}Public [get]

diff --git a/server/resource/plugin/web/api/api.js.template b/server/resource/plugin/web/api/api.js.template
@@ -3,7 +3,7 @@ import service from '@/utils/request'
 // @Tags {{.StructName}}
 // @Summary 创建{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "创建{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"创建成功"}"
@@ -19,7 +19,7 @@ export const create{{.StructName}} = (data) => {
 // @Tags {{.StructName}}
 // @Summary 删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "删除{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}"
@@ -35,7 +35,7 @@ export const delete{{.StructName}} = (params) => {
 // @Tags {{.StructName}}
 // @Summary 批量删除{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body request.IdsReq true "批量删除{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}"
@@ -51,7 +51,7 @@ export const delete{{.StructName}}ByIds = (params) => {
 // @Tags {{.StructName}}
 // @Summary 更新{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data body model.{{.StructName}} true "更新{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"更新成功"}"
@@ -67,7 +67,7 @@ export const update{{.StructName}} = (data) => {
 // @Tags {{.StructName}}
 // @Summary 用id查询{{.Description}}
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query model.{{.StructName}} true "用id查询{{.Description}}"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}"
@@ -83,7 +83,7 @@ export const find{{.StructName}} = (params) => {
 // @Tags {{.StructName}}
 // @Summary 分页获取{{.Description}}列表
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query request.PageInfo true "分页获取{{.Description}}列表"
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}"
@@ -100,7 +100,7 @@ export const get{{.StructName}}List = (params) => {
 // @Tags {{.StructName}}
 // @Summary 获取数据源
 // @Security ApiKeyAuth
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Success 200 {string} string "{"success":true,"data":{},"msg":"查询成功"}"
 // @Router /{{.Abbreviation}}/find{{.StructName}}DataSource [get]
@@ -114,7 +114,7 @@ export const get{{.StructName}}DataSource = () => {
 {{- end}}
 // @Tags {{.StructName}}
 // @Summary 不需要鉴权的{{.Description}}接口
-// @accept application/json
+// @Accept application/json
 // @Produce application/json
 // @Param data query request.{{.StructName}}Search true "分页获取{{.Description}}列表"
 // @Success 200 {object} response.Response{data=object,msg=string} "获取成功"
@@ -124,4 +124,4 @@ export const get{{.StructName}}Public = () => {
     url: '/{{.Abbreviation}}/get{{.StructName}}Public',
     method: 'get',
   })
-}
+}