MCBBS Wiki:API:修订间差异

无编辑摘要
→‎响应:​ // Edit via Wikiplus
 
(未显示同一用户的19个中间版本)
第2行: 第2行:


关于直接向 MediaWiki 请求数据的API,请参见[https://mcbbs.wiki/api.php]
关于直接向 MediaWiki 请求数据的API,请参见[https://mcbbs.wiki/api.php]
[https://github.com/mcbbs-wiki/wiki-api GitHub 仓库]
==积分查询==
==积分查询==
<code style="background-color:#3bd671;color:#ffffff;border-color:#3bd671;">GET</code>{{code|/913-api/users/UID}}
<code style="background-color:#3bd671 !important;color:#ffffff;border-color:#3bd671;">GET</code> {{code|/rest.php/mbwutils/v0/credit/UID}}
===路径参数===
===参数===
{| class="wikitable"
{| class="wikitable"
|+ 路径参数
! 参数名
! 参数名
! 类型
! 类型
第14行: 第17行:
|}
|}
===响应===
===响应===
以 UID 3038 为例。
以 UID 3038(混乱)为例。
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
   "uid": 3038, // 用户 UID
   "uid": 3038,
   "nickname": "混乱", // 用户名
  "update": "2023-07-11 06:51:25",
  "notfound": false,
   "nickname": "混乱",
   "credits": {
   "credits": {
     "heart": 0, // 爱心数
     "credit": 48334,
    "contribute": 165, // 贡献数
     "popularity": 11909,
    "diamond": 3447, // 钻石数
     "nugget": 12996,
     "popularity": 11454, // 人气数
     "ingot": 0,
     "credit": 46696, // 积分总数
     "gem": 11,
     "nugget": 10648, // 金粒数
     "star": 1,
     "gem": 11, // 宝石数
     "contribute": 191,
    "ingot": 0, // 金锭数
     "heart": 0,
     "star": 1 // 下界之星数
     "diamond": 3447
  },
  "activites": {
    "post": 6791, // 回帖数
     "thread": 577, // 主题数
     "digiest": 4, // 精华数
     "userGroups": [ // 用户所拥有的用户组(机器可读)
      "admin",
      "artist",
      "super_moderator"
    ],
    "userGroupsText": [ // 用户所拥有的用户组(人类可读)
      "管理员",
      "Lv.Inf 艺术家",
      "超级版主"
    ],
    "currentGroup": "admin", // 用户当前的用户组(机器可读)
    "currentGroupText": "管理员" // 用户当前的用户组(人类可读)
   },
   },
   "locked": false // 用户是否被锁定
   "activities": {
    "post": 6801,
    "thread": 581,
    "digiest": 4,
    "currentGroupID": 28,
    "currentGroupText": "Lv.11 领主"
  }
}
}
</syntaxhighlight>
</syntaxhighlight>
第67行: 第61行:
| 无法从 MCBBS 获取积分信息。
| 无法从 MCBBS 获取积分信息。
|}
|}
==论坛梗图==
==论坛梗图==
<code style="background-color:#3bd671;color:#ffffff;border-color:#3bd671;">GET</code>{{code|/913-api/imgs/PID}}
<code style="background-color:#3bd671 !important;color:#ffffff;border-color:#3bd671;">GET</code> {{code|/bbs-img/PID}}
===路径参数===
===参数===
{| class="wikitable"
{| class="wikitable"
! 参数名
|+ 路径参数
! 类型
! 描述
! 必须
|-
|-
| PID || number|| 要查询图片的 PID,未指定则随机抽取。 || 
|}
===查询参数===
{| class="wikitable"
! 参数名
! 参数名
! 类型
! 类型
第85行: 第73行:
! 必须
! 必须
|-
|-
| type || string || API 返回信息类型。<br>默认值:img<br>可以是以下其中之一:img,json || 
| PID
| number
| 要查询图片的 PID,未指定则随机抽取。
|}
|}
===响应===
===响应===
当 type 为 img 时,将会重定向至{{code|Content-Type}}为{{code|image/webp}}的 webp 图片。
重定向至图片的 URL,所有图片均为 webp 格式。


当 type 为 json 时,将返回以下 JSON 数据。
<syntaxhighlight lang="JSON">
{
  "id": 3, // 图片 PID
  "path": "/images/memes/3.webp", // 图片的相对地址
  "page": "混乱" // 图片对应的 Wiki 页面
}
</syntaxhighlight>
===响应状态代码===
===响应状态代码===
{| class="wikitable"
{| class="wikitable"
! 状态
! 状态
! 描述
! 描述
|-
| 200
| OK(仅当 type 为 json 时)
|-
|-
| 302  
| 302  

2024年2月25日 (日) 10:05的最新版本

本页记录了 MCBBS Wiki 上所有可调用的 API。

关于直接向 MediaWiki 请求数据的API,请参见[1]

GitHub 仓库

积分查询

GET /rest.php/mbwutils/v0/credit/UID

参数

路径参数
参数名 类型 描述 必须
UID number 要查询用户的 UID。

响应

以 UID 3038(混乱)为例。

{
  "uid": 3038,
  "update": "2023-07-11 06:51:25",
  "notfound": false,
  "nickname": "混乱",
  "credits": {
    "credit": 48334,
    "popularity": 11909,
    "nugget": 12996,
    "ingot": 0,
    "gem": 11,
    "star": 1,
    "contribute": 191,
    "heart": 0,
    "diamond": 3447
  },
  "activities": {
    "post": 6801,
    "thread": 581,
    "digiest": 4,
    "currentGroupID": 28,
    "currentGroupText": "Lv.11 领主"
  }
}

响应状态代码

状态 描述
200 OK
400 请求参数错误。
404 未找到用户或无法访问用户页面。
500 无法从 MCBBS 获取积分信息。

论坛梗图

GET /bbs-img/PID

参数

路径参数
参数名 类型 描述 必须
PID number 要查询图片的 PID,未指定则随机抽取。

响应

重定向至图片的 URL,所有图片均为 webp 格式。

响应状态代码

状态 描述
302 重定向至图片的 URL。
400 请求参数错误。
404 未找到图片。