# 总览

Discuz! Q 采用 JSON 构建 API 的标准指南

JSON API 是数据交互规范,用以定义客户端如何获取与修改资源,以及服务器如何响应对应请求。

JSON API 设计用来最小化请求的数量,以及客户端与服务器间传输的数据量。在高效实现的同时,无需牺牲可读性、灵活性和可发现性。

JSON API 需要使用 JSON API 媒体类型(application/vnd.api+json) 进行数据交互。

JSON API 服务器支持通过 GET 方法获取资源。而且必须独立实现 HTTP POST, PUT 和 DELETE 方法的请求响应,以支持资源的创建、更新和删除。

JSON API 服务器也可以选择性支持 HTTP PATCH 方法 [RFC5789]和 JSON Patch 格式 [RFC6902],进行资源修改。JSON Patch 支持是可行的,因为理论上来说,JSON API 通过单一 JSON 文档,反映域下的所有资源,并将 JSON 文档作为资源操作介质。在文档顶层,依据资源类型分组。每个资源都通过文档下的唯一路径辨识。

具体可参考 jsonapi.org

# REST API v1

# 当前版本

默认情况下,所有 https://discuz.chat/api 接收 v1 版本的 REST API 的请求。我们建议您通过 Accept header 明确请求此版本。所有数据都以 JSON 的形式发送和接收。

  Accept: application/vnd.api+json

# 认证方式

目前所有的接口使用 Oauth2 Password 方式,也就是 JWT Authorization Bearer header 进认证。

# 目录

# 站点

# 用户

# 用户认证

# 公众号授权方式 - 微信 pc 登录

# 用户组

# 权限

# 通知

# 分类

# 主题

# 回复

# 附件

# 敏感词

# 表情

# 邀请

# 订单

# 钱包

# 短信

# 设置

# 财务

# 关注

# 私信

# 话题

最后更新: 8/4/2020, 11:50:19 AM