menu Chancel's blog
rss_feed
Chancel's blog
有善始者实繁,能克终者盖寡。

Apis

作者:Chancel Yang, 创建:2023-07-18, 字数:2558, 已阅:422, 最后更新:2024-03-10

1. 服务说明

以下会涉及到一些博客的 API 接口,仅提供开发和测试调用

出于博客程序版本更新可能导致的 BUG,我不建议将博客的 API 接口用于生产环境

考虑到安全性问题,对于一些敏感的 API 调用(例如涉及资源消耗的操作),会限制单位时间内的请求次数。

API 接口会不定期进行更新,如果发现 API 有请求方面的问题欢迎随时留言告知

2. 服务分享

2.1. http 加速服务

服务:https://agent.chancel.me

此服务可以解决在服务器上无法顺利连接到github.com等网络状况不佳的网站

目前服务仅支持debian.orggithub.com以及raw.githubusercontent.com

使用方法

  1. 将原域名作为路径,域名替换为agent.chancel.me进行操作

举例

  • 源目标:https://raw.githubusercontent.com/aristocratos/btop/main/CMakeLists.txt
  • 更改为:https://agent.chancel.me/raw.githubusercontent.com/aristocratos/btop/main/CMakeLists.txt

2.2. syncthing 中继服务

服务: relay://www.chancel.me:2206/?id=ZY73TOU-DLR4KHS-TMQTTTP-QG22MQX-XY4PBUO-GX3OLFD-DGQT6RY-HRV37A5

syncthing 是一款非常好用的 p2p 同步软件,但国内复杂的 NAT 网络偶尔导致同步文件很慢,借助上面的中继服务器可以实现稳定的文件同步

使用方法

  1. 打开 syncthing 控制台,选 settings-connections
  2. 在 sync protcol listen address 中填入relay://[domain:port]/?id=[id]

如图

2.3. Gravatar 头像加速服务

地址:https://gravatar.chancel.me/avatar

使用方法

  1. n 将 Gravatar 官方链接替换为上述链接

2.4. PlantUML 插件服务(Joplin)

地址:https://plantuml.chancel.me

使用方法

  1. 打开 Joplin 菜单栏-Tools-Options-Plugins 并安装 PlantUMl 插件
  2. 安装完成后,在 Joplin 菜单栏-Tools-Options-Plugins 子类中选择 PlantUML 插件,选择私有服务器,并填入上述服务地址,如图

搭建文档参考: plantuml/plantuml-server - github.com

3. API 列表

3.1. 随机图片获取

地址:https://api.chancel.me/rest/api/v1/image

请求方法:GET

接口说明:用于获取随机 webp 图片,尺寸是 1920x1080,支持自定义宽度或者高度,图片来源网络不做内容保证

请求参数

参数名称 参数类型 是否必须 说明
id string 指定 ID 可每次获取相同图片
height int 指定高度(宽度根据图片自适应)
width int 指定宽度(高度根据图片自适应)

返回参数

二进制图片内容

3.2. IP 查询

地址:https://api.chancel.me/rest/api/v1/ip

请求方法:GET

接口说明:返回调用者的 IP

请求参数

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

返回参数

参数名称 参数类型 实例值 说明
status int 0/1 处理结果,成功是 1,错误是 0
message string 查询 IP 成功 请求处理的消息
data dict - 请求处理返回的数据(IP 地址)

CURL - 示例

Bash
curl https://api.chancel.me/rest/api/v1/ip

返回示例

JSON
{
  "data": {
    "ip": "173.242.127.92"
  },
  "message": "查询成功",
  "status": 1
}

[[replyMessage== null?"发表评论":"发表评论 @ " + replyMessage.m_author]]

account_circle
email
web_asset
textsms

评论列表([[messageResponse.total]])

还没有可以显示的留言...
[[messageItem.m_author]] [[messageItem.m_author]]
[[messageItem.create_time]]
[[getEnviron(messageItem.m_environ)]]
[[subMessage.m_author]] [[subMessage.m_author]] @ [[subMessage.parent_message.m_author]] [[subMessage.parent_message.m_author]]
[[subMessage.create_time]]
[[getEnviron(messageItem.m_environ)]]