论坛 API 文档现已开放,让我们一起把社区能力接出去!
以前论坛里的很多能力基本只服务于网页本身,例如资源、地图、蓝图、用户信息等。对于想做 Mindustry Mod、第三方启动器、资源管理器、机器人或者其他社区工具 的开发者来说,要么不知道接口在哪里,要么只能自己研究网页请求。
所以我们准备把这件事正式一点:
MDTBBS 将逐步开放公共 API,并提供面向第三方开发者的 API 文档。
API 文档入口:
API 文档里有什么?
文档会直接基于 MDTBBS 当前实际提供的接口整理
目前文档中会展示:
接口地址与请求方式
请求参数说明
返回数据结构
错误码与异常响应
认证方式
分页、筛选等公共参数
JavaScript / TypeScript / Java / Kotlin / cURL 等调用示例
以后论坛 API 有调整时,也会尽量保证 /api/v1/* 的兼容性,避免第三方项目因为论坛内部的一次改动直接失效。
这些 API 能拿来做什么?
比如:
在 Mindustry Mod 里直接浏览社区资源
制作第三方 Mindustry 启动器
搜索、查看和下载地图、蓝图等资源
制作桌面端或移动端 MDTBBS 客户端
制作资源管理器、资源站聚合工具
做你想做的事情(
论坛不一定只能存在于浏览器里,而是可以存在于不同的应用中
如果有人愿意折腾,我们希望 MDTBBS 的资源和社区能力能够出现在更多地方
API 还在继续完善
目前这套 API 并不是“已经全部完成,以后不动了”的最终版本,它还会随着论坛继续开发,有些能力已经可以稳定使用,有些接口还在补充,还有一些需求可能只有真正开始开发第三方项目以后才能发现。
所以如果你在开发过程中发现:
缺少某个很有用的接口
返回的数据不够
字段设计不方便使用
文档写错了或者没有说明清楚
某个接口对于 Mod / 启动器来说调用起来很别扭
有更合理的 API 设计方案
欢迎提出指导
API 最终是给开发者用的,如果只有论坛自己觉得“这个接口设计得挺合理”,结果第三方真正接入的时候发现到处绕路,那这个 API 设计其实就没有达到目的。所以
欢迎一起共建
MDTBBS 本身也是一个长期折腾出来的社区项目,所以 API 这部分同样欢迎大家参与。
很多真正有用的接口,不一定是我们坐在这里提前设计出来的,而是在实际开发和接入过程中慢慢发现而创造出来的。
关于第三方项目
我们欢迎第三方客户端、启动器、Mod 和工具调用 MDTBBS 的公开 API。
第三方项目也不需要与我们绑定,你完全可以按照自己的想法开发自己的项目
如果你的项目已经接入 MDTBBS API,也欢迎在论坛发布,我们将为基于论坛而开发的应用提供高速下载地址
API 版本
目前公开 API 以:
/api/v1/*作为主要版本路径。
以后如果出现较大的不兼容改动,会通过新的 API 版本处理,而不是直接把现有第三方程序全部干碎。
当然,在 API 还处于持续建设阶段的现在,一些接口和字段仍然可能进行调整。
资源、地图、蓝图、账号、搜索,以及以后更多能力,都可以逐渐变成开放的社区基础设施。
网页只是其中一个入口。
所以开放了互联api
如果你正在开发 Mindustry 相关项目,或者单纯想拿 API 做点有意思的东西,欢迎来试。
API 文档
如果遇到什么问题请在此帖或运营反馈板块留言