IconCreated with Sketch.

YAPI 接口文档

YApi
  • 公共分类
    • 获取上传文件
    • 获取文件内容
    • 获取文件内容(w_100)
    • 获取文件地址

IMG

平台处理图片系统

公共信息

通用性错误

名称 类型 默认值 是否必须 说明 备注
success boolean 必须 请求状态
data object 非必须 请求内容
errorCode string 非必须 异常编码
errorMessage string 非必须 异常内容
showType integer 非必须 前端动作
traceId string 必须 追踪ID
{
  "success": false,
  "data": "string",
  "errorCode": "S_SERVE_FORBIDDEN",
  "errorMessage": "用户未得到授权,访问是被禁止的",
  "showType": 1,
  "traceId": "e59e6f078389d36c2bb06d29297b5b86"
}

前端动作类型, 页面的内容应该有前端拦截器统一处理

名称 类型 值 动作 备注
ShowNone 0 静音
ShowWarn 1 消息警告
ShowError 2 消息错误
ShowNotify 4 通知
ShowPage 9 页面跳转

IMG服务器

测试服务器:https://img.dev1.sims-cn.com
正式服务器:https://img.con.plscn.com

备注

插件安装: https://microsoftedge.microsoft.com/addons/detail/crossrequest/bephiepmhphdlafkfonngafenjhfehlb

公共分类

获取上传文件

基本信息

Path: /oss/v1/file/upload

Method: GET

接口描述:

获取文件的上传地址,用于前端直传文件

请求参数

Query

参数名称 是否必须 示例 备注
folder 是 上传的文件夹
name 是 上传文件的原始名称
permission 是 上传文件的权限 0< x < 255, => 0377

返回数据

名称类型是否必须默认值备注其他信息
successboolean非必须
dataobject非必须
├─ hoststring非必须访问地址
├─ filenamestring非必须上传的文件唯一路径
├─ paramsnull非必须上传文件参数
├─ headersnull非必须上传文件请求头
traceIdstring非必须

获取文件内容

基本信息

Path: /oss/v1/file/1

Method: GET

接口描述:

直接获取原始文件

请求参数

Query

参数名称 是否必须 示例 备注
filename 是 文件路径
style 否 文件风格

返回数据

名称类型是否必须默认值备注其他信息

获取文件内容(w_100)

基本信息

Path: /oss/v1/file/0

Method: GET

接口描述:

直接下载文件,获取文件的内容,图片进行裁剪,宽度为100

请求参数

Query

参数名称 是否必须 示例 备注
filename 是 文件路径

返回数据

名称类型是否必须默认值备注其他信息

获取文件地址

基本信息

Path: /oss/v1/file

Method: GET

接口描述:

获取文件下载地址,前端需要通过location自己重定向, 注意,下载连接60秒有效

请求参数

Query

参数名称 是否必须 示例 备注
filename 是 /fmes/38984/aAP80000000N2Ptd211Y1Tsdfads2343.png 文件路径
style 否 风格

返回数据

名称类型是否必须默认值备注其他信息
successboolean非必须
dataobject非必须
├─ locationstring必须文件下载地址
traceIdstring非必须

Build by YMFE.