画师助手接口文档

用户注册

用户注册接口

url/users/register

method

post

参数

支持同时 form-data 和 application/json

  • email :邮箱,string
  • password :密码,string
  • rpassword :确认密码,string

响应

{"success": false, "msg": "错误信息", "code": 400}
{"success": true, "msg": "注册成功, 请点击邮箱激活链接激活", "code": 200}

用户登陆

用户登陆

url :/users/login

method

post

参数

支持同时 form-data 和 application/json

  • email :邮箱,string
  • password :密码,string

响应

{"success": true, "msg": "登陆成功", "code": 200, "token": token}
{"success": false, "msg": "错误信息", "code": 400}

用户详情

获取用户详情

url :/users/info

method

get

header

Authorization Bearer {token}

响应

{
    "code": 200,
    "data": {
        "email": "919624032@qq.com",
        "nickname": "",# 昵称
        "avatar": "",  # 头像
        "info": "",    # 用户详情
        "is_vip": false,
        "capacity_all": 0, # 总容量。单位byte
        "capacity_left": 0, # 剩余容量。单位byte
        "integral": 0  # 积分
    },
    "msg": "获取成功",
    "success": true
}

{
    "code": 401,
    "msg": "用户未登陆",
    "success": false
}

code 为401时候跳转到登陆页面

用户详情修改

url :/users/info

method

put

header

Authorization Bearer {token}

参数

  • nickname :昵称,string
  • avatar :头像url,string
  • info :个人简介,string

响应

regia.Map{"success": false, "msg": "请上传正确的url地址", "code": 400}
{"success": true, "msg": "更新成功", "code": 200}

用户作品列表

获取当前用户的作品列表

url/users/productions/

method

get

header

Authorization Bearer {token}

参数

  • page :当前页码,默认1,int
  • page_size : 每页数据条数,默认10,int

响应

{
    "code": 200,
    "data": [
        {
            "id": 1,
            "size": 1024,  # 作品的大小,单位字节
            "create_time": 111111111, # 创建时间
            "path": "/path", # 作品的路径
            "name": "鲜见"  # 作品的备注
        }
    ],
    "msg": "获取成功",
    "success": true
}


{
    "code": 401,
    "msg": "用户未登陆",
    "success": false
}

作品重命名

重命名用户的作品

url : /users/productions/rename

method

post

header

Authorization Bearer {token}

参数

  • id :作品的id,int
  • name :新名称,string

响应

{"success": true, "msg": "更新成功", "code": 200}
{"success": false, "msg": "当前用户无该作品信息", "code": 400}
{
    "code": 401,
    "msg": "用户未登陆",
    "success": false
}

作品删除

删除用户作品

url/users/productions/{production_id}/

作品id传在url上面

header

Authorization Bearer {token}

method

delete

参数

  • production_id :作品id ,传在url路径上面,int

响应

{"success": false, "code": 404, "msg": "无作品信息", "data": {}}
{"success": true, "msg": "删除成功", "code": 200}

草稿列表

获取当前用户的草稿列表

url :/users/draft/

method

get

header

Authorization Bearer {token}

参数

  • page :当前页码,默认1,int
  • page_size : 每页数据条数,默认10,int

响应

{
    "code": 200,
    "data": [
        {
            "id": 1,
            "size": 91588,   # 文件大小。单位字节
            "create_time": 1634696417,  # 创建时间
            "path": "upload/Rv4hsOMsrc=http___hbimg.b0.upaiyun.com_62f787bd2325bdeff7d9bdaa25c94be8456e3b501becc-l61Pfu_fw658&refer=http___hbimg.b0.upaiyun.jpeg",  # 路径
            "name": "新建草稿"
        }
    ],
    "msg": "获取成功",
    "success": true
}

{
    "code": 401,
    "msg": "用户未登陆",
    "success": false
}

创建草稿

上传用户草稿

url :/users/draft/

method

post

header

Authorization Bearer {token}

参数

  • content:文件内容,string

响应

{"success": true, "msg": "保存成功", "code": 200}
{"success": false, "msg": "上传失败", "code": 400}
{
    "code": 401,
    "msg": "用户未登陆",
    "success": false
}

草稿重命名

重命名草稿

url/users/draft/rename

method

post

header

Authorization Bearer {token}

参数

  • id :草稿的id,int
  • name :新名字,string

响应

{"success": false, "msg": "当前用户无此草稿信息", "code": 400}
{"success": true, "msg": "更新成功", "code": 200}
{
    "code": 401,
    "msg": "用户未登陆",
    "success": false
}

草稿删除

草稿删除

url/users/draft/{id}

method

delete

header

Authorization Bearer {token}

参数

  • id :草稿的id,int

响应

{"success": false, "code": 404, "msg": "无作品信息", "data": {}}
{"success": true, "msg": "删除成功", "code": 200}
{
    "code": 401,
    "msg": "用户未登陆",
    "success": false
}

文件上传

url :/upload-file

method

post

header

Authorization Bearer {token}

参数

  • file:文件,file

响应

{"success": false, "msg": "保存失败", "code": 400}
{"success": true, "msg": "上传成功", "data": "完整的文件访问路径", "code": 200}

购买容量

url :/users/buy/cap

method :post

参数

  • cap : 需要购买的容量,int,单位G

header

Authorization Bearer {token}

响应

{"success": false, "msg": "余额不足", "code": 400}
{"success": true, "msg": "充值成功", "code": 200}

购买算力

url :/users/buy/compute

method :post

header

Authorization Bearer {token}

参数

  • compute : 购买的算力, int

响应

{"success": false, "msg": "compute参数错误", "code": 500}
{"success": true, "msg": "充值成功", "code": 200}

创建铸件

url :/users/productions/casting

method :post

header

Authorization Bearer {token}

参数

  • id :作品id,int
  • image_list : 图片列表, []int64.[1,2,3,4]
  • cover :封面url,string
  • name :作品名称,string
  • info :作品简介,string
  • price :价格,float64
  • royalties :版税,int。4-10 之间
  • type :类型,int,1-5之间

响应

{"success": true, "msg": "ok", "code": 200, "data": "code"}

获取铸件

url :/api/v1/public/production/{code}

method :get

响应

{"success": false, "code": 404, "message": "无铸件信息", data:""}
{"success": false, "code": 400, "message": "code已过期", data:""}
{"success": true, "code": 200, "message": "ok", data: {"data": {
  "id": 1,
  "user_id": 2,
  "product_id": 2,
  "cover": "封面url",
  "name": "铸件名称",
  "info": "铸件简介",
  "price": 0.01, // 铸件价格
  "royalties": 4, // 版税 4 为4%
  "type": 1, // 类型id
  "code": "asdsa", // 铸件码
  "create_time": 11111 // 创建时间时间戳
}, "link": "下载链接"}}

图片列表

url :http://localhost:8086/users/productions/{id}/images

method :get

header

Authorization Bearer {token}

参数

  • id :作品的id,传在url上面

响应

{
    "code": 200,
    "data": {
        "count": 1,
        "result": [
            {
                "id": 0,
                "path": "http://192.168.2.173:8086/picture_out/qJMYJGI/images-0.png"
            }
        ]
    },
    "msg": "ok",
    "success": true
}

图片生成

现在需要用户登陆才能生成图片

鉴权

在建立连接的时候,在头部传递token,方式跟上面的一样

如果没有登陆,在ws连接完成之后,会发送一条信息

{"success": false, "message": "用户为未登陆", "code": 401, "data": ""}

上传图片数据

{
  data: {}, // 之前的原始数据
  type: 0,  // 0:正常生成,1: 算力不足时继续生成
}

返回数据

{success:false, message:"用户容量不足", code: 400, data: ""} 
// ws会立即中断连接

{success: false, message: "用户算力不足", code: 450, data: ""} 
// ws会立即中断连接,当算力不足时候, 可以询问用户是否继续,如果继续,则将上传数据的type改为1

{success: false, message: "算力为空,请充值", code: 451, data: ""} 
// ws会立即中断连接,算力为空,不需要询问用户是否继续

{success: true, data:"路径", message: "该链接3天后失效", code: 250}
// 使用免费机会生成

{success: true, data: "路径", message: "保存成功", code: 200}
// 保存成功

{count: 100, current: 100, meta: "xxx"}
// 进度条信息

app申请

url/users/app/apply

method :post

header

Authorization Bearer {token}

参数

  • app_name : app的名字
  • reason :申请理由

响应

{"success": true, "msg": "申请成功,等待管理员审核", "code": 200}

获取access-token

url :/api/v1/access-token

methodget

参数

  • app_id
  • app_secret

响应

{
		"success": true,
		"msg":     "success",
		"code":    200,
		"data": regia.Map{
			"access_token": accessToken,
			"expire_in":    7200,
		}}

生成图片

url :/api/v1/gen-image

method :post

参数

  • access_token :token
  • layer : [] {“R”: 10, “G”: 10, “B”: A}
  • store :是否存储

响应

{Code: 201, Message: "ok", Success: true, Data: path}