上传项目api文档

bin/梦工厂后台AIP文档.md

@@ -0,0 +1,39 @@
+## 梦工厂后台AIP文档
+
+### Api格式规范
+- 请求URL {IP}:{port}/{接口名}
+- 请求方式 POST
+- 请求参数 json
+- 签名秘钥 @234%67g12q4*67m12#4l67!
+- 签名方式 sign = k1=v1&k2=v2&key=@234%67g12q4*67m12#4l67! 
+- 注意 签名字段需要按字段名排序拼接
+
+### 样例Api
+- 接口名:test
+- 接口说明:样例接口 提供api文档规范
+- 请求地址:{IP}:{port}/test
+- 请求参数:id(测试id),name(测试名称),items(内嵌接口演示),sign(签名)
+- 请求样例
+```
+{
+    "id":"001",
+    "name":"test"
+    "items":[
+        {
+            "A":"",
+            "T":"",
+            "N":0
+        }
+    ],
+    "sign":"asjioqiowjeioqjweijqwejoi"
+}
+```
+- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
+- 返回样例
+```
+{
+    "code":0,
+    "msg":"成功",
+    "data":"",
+}
+```

modules/web/api_creatmail.go

@@ -14,9 +14,9 @@ type CrateMailReq struct {
 	Uid    string           `json:"uid"`    // uid
 	Title  string           `json:"title"`  // 邮件标题
 	Contex string           `json:"contex"` // 邮件内容 支持自定义
-	Items  []*pb.UserAssets // 附件
+	Items  []*pb.UserAssets `json:"items"`  // 附件
 	Cid    string           `json:"cid"`    // 多语言表id
-	Param  []string         // 自定义参数
+	Param  []string         `json:"param"`  // 自定义参数
 	Sign   string           `json:"sign"`
 }