api.go.tpl 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. package {{.Package}}
  2. import (
  3. {{if not .OnlyTemplate}}
  4. "{{.Module}}/global"
  5. "{{.Module}}/model/common/response"
  6. "{{.Module}}/model/{{.Package}}"
  7. {{- if not .IsTree}}
  8. {{.Package}}Req "{{.Module}}/model/{{.Package}}/request"
  9. {{- end }}
  10. "github.com/gin-gonic/gin"
  11. "go.uber.org/zap"
  12. {{- if .AutoCreateResource}}
  13. "{{.Module}}/utils"
  14. {{- end }}
  15. {{- else}}
  16. "{{.Module}}/model/common/response"
  17. "github.com/gin-gonic/gin"
  18. {{- end}}
  19. )
  20. type {{.StructName}}Api struct {}
  21. {{if not .OnlyTemplate}}
  22. // Create{{.StructName}} 创建{{.Description}}
  23. // @Tags {{.StructName}}
  24. // @Summary 创建{{.Description}}
  25. // @Security ApiKeyAuth
  26. // @Accept application/json
  27. // @Produce application/json
  28. // @Param data body {{.Package}}.{{.StructName}} true "创建{{.Description}}"
  29. // @Success 200 {object} response.Response{msg=string} "创建成功"
  30. // @Router /{{.Abbreviation}}/create{{.StructName}} [post]
  31. func ({{.Abbreviation}}Api *{{.StructName}}Api) Create{{.StructName}}(c *gin.Context) {
  32. // 创建业务用Context
  33. ctx := c.Request.Context()
  34. var {{.Abbreviation}} {{.Package}}.{{.StructName}}
  35. err := c.ShouldBindJSON(&{{.Abbreviation}})
  36. if err != nil {
  37. response.FailWithMessage(err.Error(), c)
  38. return
  39. }
  40. {{- if .AutoCreateResource }}
  41. {{.Abbreviation}}.CreatedBy = utils.GetUserID(c)
  42. {{- end }}
  43. err = {{.Abbreviation}}Service.Create{{.StructName}}(ctx,&{{.Abbreviation}})
  44. if err != nil {
  45. global.GVA_LOG.Error("创建失败!", zap.Error(err))
  46. response.FailWithMessage("创建失败:" + err.Error(), c)
  47. return
  48. }
  49. response.OkWithMessage("创建成功", c)
  50. }
  51. // Delete{{.StructName}} 删除{{.Description}}
  52. // @Tags {{.StructName}}
  53. // @Summary 删除{{.Description}}
  54. // @Security ApiKeyAuth
  55. // @Accept application/json
  56. // @Produce application/json
  57. // @Param data body {{.Package}}.{{.StructName}} true "删除{{.Description}}"
  58. // @Success 200 {object} response.Response{msg=string} "删除成功"
  59. // @Router /{{.Abbreviation}}/delete{{.StructName}} [delete]
  60. func ({{.Abbreviation}}Api *{{.StructName}}Api) Delete{{.StructName}}(c *gin.Context) {
  61. // 创建业务用Context
  62. ctx := c.Request.Context()
  63. {{.PrimaryField.FieldJson}} := c.Query("{{.PrimaryField.FieldJson}}")
  64. {{- if .AutoCreateResource }}
  65. userID := utils.GetUserID(c)
  66. {{- end }}
  67. err := {{.Abbreviation}}Service.Delete{{.StructName}}(ctx,{{.PrimaryField.FieldJson}} {{- if .AutoCreateResource -}},userID{{- end -}})
  68. if err != nil {
  69. global.GVA_LOG.Error("删除失败!", zap.Error(err))
  70. response.FailWithMessage("删除失败:" + err.Error(), c)
  71. return
  72. }
  73. response.OkWithMessage("删除成功", c)
  74. }
  75. // Delete{{.StructName}}ByIds 批量删除{{.Description}}
  76. // @Tags {{.StructName}}
  77. // @Summary 批量删除{{.Description}}
  78. // @Security ApiKeyAuth
  79. // @Accept application/json
  80. // @Produce application/json
  81. // @Success 200 {object} response.Response{msg=string} "批量删除成功"
  82. // @Router /{{.Abbreviation}}/delete{{.StructName}}ByIds [delete]
  83. func ({{.Abbreviation}}Api *{{.StructName}}Api) Delete{{.StructName}}ByIds(c *gin.Context) {
  84. // 创建业务用Context
  85. ctx := c.Request.Context()
  86. {{.PrimaryField.FieldJson}}s := c.QueryArray("{{.PrimaryField.FieldJson}}s[]")
  87. {{- if .AutoCreateResource }}
  88. userID := utils.GetUserID(c)
  89. {{- end }}
  90. err := {{.Abbreviation}}Service.Delete{{.StructName}}ByIds(ctx,{{.PrimaryField.FieldJson}}s{{- if .AutoCreateResource }},userID{{- end }})
  91. if err != nil {
  92. global.GVA_LOG.Error("批量删除失败!", zap.Error(err))
  93. response.FailWithMessage("批量删除失败:" + err.Error(), c)
  94. return
  95. }
  96. response.OkWithMessage("批量删除成功", c)
  97. }
  98. // Update{{.StructName}} 更新{{.Description}}
  99. // @Tags {{.StructName}}
  100. // @Summary 更新{{.Description}}
  101. // @Security ApiKeyAuth
  102. // @Accept application/json
  103. // @Produce application/json
  104. // @Param data body {{.Package}}.{{.StructName}} true "更新{{.Description}}"
  105. // @Success 200 {object} response.Response{msg=string} "更新成功"
  106. // @Router /{{.Abbreviation}}/update{{.StructName}} [put]
  107. func ({{.Abbreviation}}Api *{{.StructName}}Api) Update{{.StructName}}(c *gin.Context) {
  108. // 从ctx获取标准context进行业务行为
  109. ctx := c.Request.Context()
  110. var {{.Abbreviation}} {{.Package}}.{{.StructName}}
  111. err := c.ShouldBindJSON(&{{.Abbreviation}})
  112. if err != nil {
  113. response.FailWithMessage(err.Error(), c)
  114. return
  115. }
  116. {{- if .AutoCreateResource }}
  117. {{.Abbreviation}}.UpdatedBy = utils.GetUserID(c)
  118. {{- end }}
  119. err = {{.Abbreviation}}Service.Update{{.StructName}}(ctx,{{.Abbreviation}})
  120. if err != nil {
  121. global.GVA_LOG.Error("更新失败!", zap.Error(err))
  122. response.FailWithMessage("更新失败:" + err.Error(), c)
  123. return
  124. }
  125. response.OkWithMessage("更新成功", c)
  126. }
  127. // Find{{.StructName}} 用id查询{{.Description}}
  128. // @Tags {{.StructName}}
  129. // @Summary 用id查询{{.Description}}
  130. // @Security ApiKeyAuth
  131. // @Accept application/json
  132. // @Produce application/json
  133. // @Param {{.PrimaryField.FieldJson}} query {{.PrimaryField.FieldType}} true "用id查询{{.Description}}"
  134. // @Success 200 {object} response.Response{data={{.Package}}.{{.StructName}},msg=string} "查询成功"
  135. // @Router /{{.Abbreviation}}/find{{.StructName}} [get]
  136. func ({{.Abbreviation}}Api *{{.StructName}}Api) Find{{.StructName}}(c *gin.Context) {
  137. // 创建业务用Context
  138. ctx := c.Request.Context()
  139. {{.PrimaryField.FieldJson}} := c.Query("{{.PrimaryField.FieldJson}}")
  140. re{{.Abbreviation}}, err := {{.Abbreviation}}Service.Get{{.StructName}}(ctx,{{.PrimaryField.FieldJson}})
  141. if err != nil {
  142. global.GVA_LOG.Error("查询失败!", zap.Error(err))
  143. response.FailWithMessage("查询失败:" + err.Error(), c)
  144. return
  145. }
  146. response.OkWithData(re{{.Abbreviation}}, c)
  147. }
  148. {{- if .IsTree }}
  149. // Get{{.StructName}}List 分页获取{{.Description}}列表,Tree模式下不接受参数
  150. // @Tags {{.StructName}}
  151. // @Summary 分页获取{{.Description}}列表
  152. // @Security ApiKeyAuth
  153. // @Accept application/json
  154. // @Produce application/json
  155. // @Success 200 {object} response.Response{data=response.PageResult,msg=string} "获取成功"
  156. // @Router /{{.Abbreviation}}/get{{.StructName}}List [get]
  157. func ({{.Abbreviation}}Api *{{.StructName}}Api) Get{{.StructName}}List(c *gin.Context) {
  158. // 创建业务用Context
  159. ctx := c.Request.Context()
  160. list, err := {{.Abbreviation}}Service.Get{{.StructName}}InfoList(ctx)
  161. if err != nil {
  162. global.GVA_LOG.Error("获取失败!", zap.Error(err))
  163. response.FailWithMessage("获取失败:" + err.Error(), c)
  164. return
  165. }
  166. response.OkWithDetailed(list, "获取成功", c)
  167. }
  168. {{- else }}
  169. // Get{{.StructName}}List 分页获取{{.Description}}列表
  170. // @Tags {{.StructName}}
  171. // @Summary 分页获取{{.Description}}列表
  172. // @Security ApiKeyAuth
  173. // @Accept application/json
  174. // @Produce application/json
  175. // @Param data query {{.Package}}Req.{{.StructName}}Search true "分页获取{{.Description}}列表"
  176. // @Success 200 {object} response.Response{data=response.PageResult,msg=string} "获取成功"
  177. // @Router /{{.Abbreviation}}/get{{.StructName}}List [get]
  178. func ({{.Abbreviation}}Api *{{.StructName}}Api) Get{{.StructName}}List(c *gin.Context) {
  179. // 创建业务用Context
  180. ctx := c.Request.Context()
  181. var pageInfo {{.Package}}Req.{{.StructName}}Search
  182. err := c.ShouldBindQuery(&pageInfo)
  183. if err != nil {
  184. response.FailWithMessage(err.Error(), c)
  185. return
  186. }
  187. list, total, err := {{.Abbreviation}}Service.Get{{.StructName}}InfoList(ctx,pageInfo)
  188. if err != nil {
  189. global.GVA_LOG.Error("获取失败!", zap.Error(err))
  190. response.FailWithMessage("获取失败:" + err.Error(), c)
  191. return
  192. }
  193. response.OkWithDetailed(response.PageResult{
  194. List: list,
  195. Total: total,
  196. Page: pageInfo.Page,
  197. PageSize: pageInfo.PageSize,
  198. }, "获取成功", c)
  199. }
  200. {{- end }}
  201. {{- if .HasDataSource }}
  202. // Get{{.StructName}}DataSource 获取{{.StructName}}的数据源
  203. // @Tags {{.StructName}}
  204. // @Summary 获取{{.StructName}}的数据源
  205. // @Accept application/json
  206. // @Produce application/json
  207. // @Success 200 {object} response.Response{data=object,msg=string} "查询成功"
  208. // @Router /{{.Abbreviation}}/get{{.StructName}}DataSource [get]
  209. func ({{.Abbreviation}}Api *{{.StructName}}Api) Get{{.StructName}}DataSource(c *gin.Context) {
  210. // 创建业务用Context
  211. ctx := c.Request.Context()
  212. // 此接口为获取数据源定义的数据
  213. dataSource, err := {{.Abbreviation}}Service.Get{{.StructName}}DataSource(ctx)
  214. if err != nil {
  215. global.GVA_LOG.Error("查询失败!", zap.Error(err))
  216. response.FailWithMessage("查询失败:" + err.Error(), c)
  217. return
  218. }
  219. response.OkWithData(dataSource, c)
  220. }
  221. {{- end }}
  222. {{- end }}
  223. // Get{{.StructName}}Public 不需要鉴权的{{.Description}}接口
  224. // @Tags {{.StructName}}
  225. // @Summary 不需要鉴权的{{.Description}}接口
  226. // @Accept application/json
  227. // @Produce application/json
  228. // @Success 200 {object} response.Response{data=object,msg=string} "获取成功"
  229. // @Router /{{.Abbreviation}}/get{{.StructName}}Public [get]
  230. func ({{.Abbreviation}}Api *{{.StructName}}Api) Get{{.StructName}}Public(c *gin.Context) {
  231. // 创建业务用Context
  232. ctx := c.Request.Context()
  233. // 此接口不需要鉴权
  234. // 示例为返回了一个固定的消息接口,一般本接口用于C端服务,需要自己实现业务逻辑
  235. {{.Abbreviation}}Service.Get{{.StructName}}Public(ctx)
  236. response.OkWithDetailed(gin.H{
  237. "info": "不需要鉴权的{{.Description}}接口信息",
  238. }, "获取成功", c)
  239. }