menu Chancel's Blog
rss_feed lightbulb_outline

我的API

服务说明

博客的API接口提供开发测试调用,往后提供的API也会往开发调试这方面靠,博客API会保证 稳定性

博客的API接口不建议用于生产环境,因为博客程序会偶尔更新版本,虽然原则上已发布的API会 少改动,但万一我写出BUG呢(逃)。

出于对安全性考虑,对于部分敏感的API调用(如消耗资源类型)会限制单位时间内的请求次数。

API接口不定期更新,原则上会保证任何已经发布的API的信息不做删除,如需修改也会提前一定时间公布。

注:博客程序部署的域名已部署超过3年,请放心使用。

暂存文件上传
POST
keyboard_arrow_down

https://api.chancel.ltd/rest/api/v1/deposited

接口说明:用于暂存文件的API借口(文件<5M)

请求参数

参数名称 参数类型 是否必须 说明
file binary 文件二进制流

返回参数

参数名称 参数类型 实例值 说明
success bool true/false 请求的处理结果
message string 查询IP成功 请求处理的消息
data dict - 请求处理返回的数据(状态码/Response的headers)

CURL - 示例

curl -X 'POST' 'https://api.chancel.ltd/rest/api/v1/deposited' -H 'accept: application/json' -H 'Content-Type: multipart/form-data' -F 'file=@demo.png;type=image/png'

返回示例

{
  "success": true,
  "message": "Save file success",
  "data": {
    "file_id": "f0c71cfe-a1dd-11eb-be7e-0050560000a0"
  }
}
暂存文件下载
GET
keyboard_arrow_down

https://api.chancel.ltd/rest/api/v1/deposited/{file_id}

接口说明:用于暂存文件的API借口(文件<5M)

请求参数

参数名称 参数类型 是否必须 说明
file_id string 文件二进制流

返回参数

  • 无,发起浏览器文件下载

CURL - 示例

curl -X 'GET' 'https://api.chancel.ltd/rest/api/v1/deposited/f0c71cfe-a1dd-11eb-be7e-0050560000a0' -H 'accept: application/json'

返回示例

  • 无,发起浏览器文件下载
IP查询
GET
keyboard_arrow_down

https://api.chancel.ltd/rest/api/v1/ip

接口说明:返回调用者外网IP

请求参数

参数名称 参数类型 是否必须 说明
-- -- -- --

返回参数

参数名称 参数类型 实例值 说明
success bool true/false 请求的处理结果
message string 查询IP成功 请求处理的消息
data dict - 请求处理返回的数据(IP地址)

CURL - 示例

curl https://api.chancel.ltd/rest/api/v1/ip

返回示例

{
    "data":
    {
        "ip":"173.242.127.92"
    },
    "message":"查询IP成功",
    "success":true}
}
代理请求
POST
keyboard_arrow_down

https://api.chancel.ltd/rest/api/v1/proxy

接口说明:代理请求别的网站,常用于判断网络问题

请求参数

参数名称 参数类型 是否必须 说明
url string 请求的网址
method string 请求的方式(值为GET/POST/PUT/DELETE中的一种)
headers dict 请求的headers
data dict 请求的数据

返回参数

参数名称 参数类型 实例值 说明
success bool true/false 请求的处理结果
message string 查询IP成功 请求处理的消息
data dict - 请求处理返回的数据(状态码/Response的headers)

CURL - 示例

curl -X POST -H "Content-Type:application/json" --data '{"url":"http://www.baidu.com","headers":{"Content-Type":"application/json"},"method":"DELETE"}' https://api.chancel.ltd/rest/api/v1/proxy

返回示例

{
  "data": {
    "http_status_code": 302,
    "response_headers": {
      "Connection": "keep-alive",
      "Content-Length": "17931",
      "Content-Type": "text/html",
      "Date": "Tue, 19 Jan 2021 13:55:44 GMT",
      "Etag": "\"54d9748e-460b\"",
      "Server": "bfe/1.0.8.18"
    }
  },
  "message": "转发请求成功",
  "success": true
}