Parcourir la source

doc: 修改文档

double.huang il y a 5 ans
Parent
commit
ae5388affd

+ 50 - 0
README.md

@@ -542,6 +542,56 @@ func SysClientUpdate(ctx *Context) {
 }
 ```
 
+```xml
+<api name="batch_update" func="update" table="article" desc="更新文章" method="put">
+	<param name="article" type="[]$article" desc="文章信息" />
+	<return>
+		<success type="$success"/>
+		<failure type="$fail"/>
+	</return>
+</api>
+```
+
+Generate code:
+
+```go
+// ArticleBatchUpdate api implementation
+// @Summary 更新文章 
+// @Tags 文章
+// @Accept application/json
+// @Param Authorization header string false "认证令牌"
+// @Param article body []model.Article false "文章信息"
+// @Failure 403 {object} model.Fail
+// @Success 200 {object} model.Success
+// @Failure 500 {object} model.Fail
+// @Router /api/article/batch_update [put]
+func ArticleBatchUpdate(ctx *Context) {
+	var payload []*model.Article
+	var err error
+	var ret []int64
+	var r int64
+	if err = ctx.ShouldBindBodyWith(&payload, binding.JSON); err != nil {
+		logrus.Error(err)
+		ctx.Fail(err)
+		return
+	}
+	s := ctx.DB.NewSession()
+	funk.ForEach(payload, func(form model.Article) {
+		form.UpdateBy = null.StringFrom(ctx.GetToken().GetUserID())
+		form.UpdateTime = null.TimeFrom(time.Now().Value())
+		r, err = s.ID(form.ID.String).Update(&form)
+		ret = append(ret, r)
+	})
+	if err != nil {
+		s.Rollback()
+		logrus.Error(err)
+		ctx.Fail(err)
+		return
+	}
+	ctx.Success(ret)
+}
+```
+
 #### page
 ```xml
 <api name="page" func="page" table="sys_client" desc="客户端分页查询" method="get">

Fichier diff supprimé car celui-ci est trop grand
+ 1541 - 61
examples/blogger/doc/swagger.yaml


+ 10 - 0
examples/blogger/script/apis/article.js

@@ -31,6 +31,16 @@ module.exports.update = (data) => {
   })
 }
 
+// batchUpdate 更新文章
+module.exports.batchUpdate = (data) => {
+  const url = '/api/article/batch_update'
+  return axios({
+    url: url,
+    method: 'put',
+    data
+  })
+}
+
 // page 文章分页查询
 module.exports.page = (data) => {
   let url = '/api/article/page?'

+ 7 - 0
examples/blogger/xml/controller/article.xml

@@ -20,6 +20,13 @@
             <failure type="$fail"/>
         </return>
     </api>
+    <api name="batch_update" func="update" table="article" desc="更新文章" method="put">
+        <param name="article" type="[]$article" desc="文章信息" />
+        <return>
+            <success type="$success"/>
+            <failure type="$fail"/>
+        </return>
+    </api>
     <api name="page" func="page" table="article" method="get" desc="文章分页查询">
         <param name="page" type="int" value="1" desc="页码"/>
         <param name="size" type="int" value="15" desc="单页数"/>

Certains fichiers n'ont pas été affichés car il y a eu trop de fichiers modifiés dans ce diff