Skip to content

介绍

使用 Fresns 统一和标准化的 API 开发客户端,创建可以服务于三种环境的应用程序,只需一次开发努力,确保兼容性和效率。

返回结果格式

Fresns API 遵循 RESTful 标准,返回结果的格式如下:

参数描述
code状态码
message状态消息
data数据
json
{
    "code": 0,
    "message": "ok",
    "data": {}
}

数据规范

  • 空数组使用 []
  • 空对象使用 null
  • like/dislike/follow/block 计数类 count 参数值,如果为 null 则表示后台配置为不公开,如果为公开则是数字值。

简写 ID 介绍

简写 ID描述
sid空间 ID
rid角色 ID
aid账号 ID
uid用户 ID
gid小组 ID
htid话题 ID
gtid地理 ID
pid帖子 ID
cid评论 ID
hpid历史帖子 ID
hcid历史评论 ID
fid文件 ID
eid扩展内容 ID
nmid通知消息 ID
cmid对话消息 ID
did草稿 ID

运行模式介绍

  • 全局配置键名 site_mode
    • 公开模式,键值为 public
    • 私有模式,键值为 private
  • 每个接口的介绍页都有两种模式的账号和用户参数是否必传说明。

Released under the Apache-2.0 License