Api

durl

v1.0.0

backendApi/openApi

GET 短链列表

GET /url/list

请求参数

名称	位置	类型	必选	说明
page	query	string	true	分页
size	query	string	true	每页大小
isFrozen	query	string	false	是否冻结 1是 -1否
fullUrl	query	string	false	原始url
createTimeL	query	string	false	创建时间搜索的开始时间
createTimeR	query	string	false	创建时间搜索的结束时间
shortKey	query	string	false	短链接

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none
» data	object	true	none	none
»» len	integer	true	none	none
»» list	[object]	true	none	none
»»» id	string¦null	true	none	none
»»» shortKey	string	true	none	none
»»» fullUrl	string	true	none	none
»»» expirationTime	integer	true	none	none
»»» isFrozen	integer	true	none	none
»»» createTime	integer	true	none	none

GET 短链详情

GET /url/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none
» data	object	true	none	none
»» id	string¦null	true	none	none
»» shortKey	string	true	none	none
»» fullUrl	string	true	none	none
»» expirationTime	integer	true	none	none
»» isFrozen	integer	true	none	none
»» createTime	integer	true	none	none
»» updateTime	integer	true	none	none

PUT 修改短链

PUT /url/{id}

Body 请求参数

{
  "type": "object",
  "properties": {
    "fullUrl": {
      "type": "string",
      "title": "长链接url"
    },
    "expirationTime": {
      "type": "integer",
      "title": "过期时间"
    },
    "isFrozen": {
      "type": "integer",
      "title": "是否冻结"
    }
  },
  "required": [
    "fullUrl",
    "expirationTime",
    "isFrozen"
  ]
}

请求参数

名称	位置	类型	必选	说明
id	path	string	true	none
body	body	object	false	none
» fullUrl	body	string	true	none
» expirationTime	body	integer	true	none
» isFrozen	body	integer	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none

DELETE 删除短链

DELETE /url/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none

PUT 批量冻结短链

PUT /url/frozen

Body 请求参数

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "isFrozen": {
      "type": "integer",
      "title": "冻结字段 1为冻结 0为不冻结"
    }
  },
  "required": [
    "ids",
    "isFrozen"
  ]
}

请求参数

名称	位置	类型	必选	说明
body	body	object	false	none
» ids	body	[string]	true	none
» isFrozen	body	integer	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none

DELETE 批量删除短链

DELETE /url

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none
» data	object	true	none	none
»» requestCount	integer	true	none	none
»» delCount	integer	true	none	none
»» errIds	[string]	true	none	none

POST 设置短链

POST /url

Body 请求参数

{
  "type": "object",
  "properties": {
    "fullUrl": {
      "type": "string",
      "title": "长链接url"
    },
    "expirationTime": {
      "type": "integer",
      "title": "过期时间"
    },
    "isFrozen": {
      "type": "integer",
      "title": "是否冻结"
    }
  },
  "required": [
    "fullUrl",
    "expirationTime",
    "isFrozen"
  ]
}

请求参数

名称	位置	类型	必选	说明
body	body	object	false	none
» fullUrl	body	string	true	none
» expirationTime	body	integer	true	none
» isFrozen	body	integer	true	none

返回示例

成功

{
  "code": 200,
  "message": "请求成功",
  "data": {
    "shortKey": "2AF",
    "fullUrl": "http://www.baidu.com",
    "expirationTime": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none
» data	object	true	none	none
»» shortKey	string	true	none	none
»» fullUrl	string	true	none	none
»» expirationTime	integer	true	none	none

PUT 冻结短链

PUT /url/frozen/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none

backendApi/黑名单

GET 黑名单详情

GET /blacklist/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	true	none

返回示例

成功

{
  "code": 200,
  "message": "请求成功",
  "data": {
    "id": 1,
    "ip": "243.56.248.69",
    "createTime": 1638928286,
    "updateTime": 1638928822
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none
» data	object	true	none	none
»» id	integer	true	none	none
»» ip	string	true	none	none
»» createTime	integer	true	none	none
»» updateTime	integer	true	none	none

DELETE 删除黑名单

DELETE /blacklist/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none

PUT 修改黑名单

PUT /blacklist/{id}

Body 请求参数

{
  "type": "object",
  "properties": {
    "ip": {
      "type": "string",
      "title": "ip"
    }
  },
  "required": [
    "ip"
  ]
}

请求参数

名称	位置	类型	必选	说明
id	path	string	true	none
body	body	object	false	none
» ip	body	string	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none

POST 设置黑名单

POST /blacklist

Body 请求参数

{
  "type": "object",
  "properties": {
    "ip": {
      "type": "string",
      "title": "ip"
    }
  },
  "required": [
    "ip"
  ]
}

请求参数

名称	位置	类型	必选	说明
body	body	object	false	none
» ip	body	string	true	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none

GET 黑名单列表

GET /blacklist/list

请求参数

名称	位置	类型	必选	说明
page	query	string	true	分页
size	query	string	true	每页大小
ip	query	string	false	ip
createTimeL	query	string	false	创建时间搜索的开始时间
createTimeR	query	string	false	创建时间搜索的结束时间

返回示例

成功

{
  "code": 200,
  "message": "请求成功",
  "data": {
    "len": 1,
    "list": [
      {
        "id": 1,
        "ip": "243.56.248.69",
        "createTime": 1638928286,
        "updateTime": 1638928548
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» message	string	true	none	none
» data	object	true	none	none
»» len	integer	true	none	none
»» list	[object]	true	none	none
»»» id	integer	false	none	none
»»» ip	string	false	none	none
»»» createTime	integer	false	none	none
»»» updateTime	integer	false	none	none

数据模型