文档仓库 /home/gogs/gogs-repositories

liu599 e1e91f06a3 publish version 0.0.1 5 år sedan
README.md e1e91f06a3 publish version 0.0.1 5 år sedan

README.md

文档

基本约定

数据结构

  • File 文件

    • id 自增 主键
    • file_id 唯一key标识
    • hash_id 文件hash值用于查重 唯一
    • created_timestamp 文件创建时间
    • modified_timestamp 文件修改时间
    • file_name 文件存储名称
    • relative_path 文件存储路径
    • user_id 上传文件的用户id
  • Tag 标签

    • tid 自增 主键
    • tag_name 标签名称 唯一
    • tag_id 唯一标签ID
  • File Tag 映射表(多对多)

    • ftid 自增 主键
    • tag_id 标签ID对应Tag表
    • file_id 文件ID对应文件表
  • User 权限用户(用于登录和上传图)

    • uid 自增 主键
    • user_id 用户唯一标识
    • user_created_timestamp 用户创建时间
    • user_last_timestamp 用户最后登陆时间
  • Authorization 登录授权

    • toid 自增 主键
    • token token值
    • token_created_timestamp token创建时间
    • user_id 用户唯一标识

接口文档

  • 用户创建和删除(准备手动..因为没几个人需要)
  • 用户登录授权(有系统, 可判断权限)
  • 文件CURD(暂时有可用的系统, 需要修改)
    • /filelist POST 获取某一类型的文件列表
      • 参数 文件类型:
        • fileType:mp3
      • 返回值为数组
        • FileNo: 23
        • createdAt: 1543509878
        • fileId: "5c00177642"
        • fileName: "IMG_3252.PNG"
        • filetype: "png"
        • hashId: "d9f25b4f5d"
        • modifiedAt: 1543509878
        • relativePath: "/"
        • src: "/5c001776421aa92da962fa2c__IMG_3252.PNG"
    • /filelist GET 获取所有文件列表 返回值为数组
      • "FileNo": 1,
      • "fileName": "DkTFZgzUwAEzg1j.jpg",
      • "fileId": "5bddd24742",
      • "hashId": "58ea7605cf",
      • "createdAt": 1541263943,
      • "modifiedAt": 1541263943,
      • "relativePath": "/",
      • "src": "/5bddd247421aa966cb625f42__DkTFZgzUwAEzg1j.jpg",
      • "filetype": "jpg"
    • /nekofile/:fileid/*size GET 通过文件ID获取文件本身
      • 参数: fileid(路径中)
      • 返回值 文件本身
    • /upload POST
      • 参数:
        • name
        • relativePath
        • base64文件
      • 返回值
        • router: '文件相对路径列表'
        • file_md5_list: 文件md5值列表
        • psy_path_list: 文件物理地址列表
        • message: 上传成功的信息
    • 删除和修改的暂时没有写。
  • 标签CURD(未开发)
    • /tag POST
      • 参数:
        • tid (不带为增加, 带为修改)
        • tag_name 标签名称 唯一
        • tag_id 唯一标签ID
      • 返回值: success: true
    • /filelist/tag POST
      • 参数:
        • tag_id
        • tag_name
      • 返回:
        • 数组文件列表
  • 标签文件映射表修改(未开发)
    • /relative/add POST 增加/删除
      • 参数:
        • tag_id 唯一标签ID
        • file_id 唯一key标识