贡献者指南

首先，欢迎您加入 BACNext，为本文档添砖加瓦。继续开始贡献前，请先注意以下事项：

加入 Apifox 项目

要进行贡献，您需要先加入 Apifox 项目。您可联系 bacnext<at>protonmail<dot>com 完成这一过程。请在邮件中包含您的 常用 ID GitHub 等平台账号 用于加入 Apifox 的邮箱 等方便我们进行审核。请理解，由于加入 Apifox 项目后贡献者账号信息可见，我们需要仔细审查加入请求。在审核通过后，我们会邀请您加入项目，并在邮件回复中说明注意事项。

开始贡献

为避免造成破坏性变更，main 将受到保护。请在 develop 分支完成 API 撰写后发起合并请求，具体请见 Apifox 文档。

API 分类问题

我们文档采用 “模块-文件夹” 层级来进行区分，一般情况下，一个 b站域名我们使用一个模块，如 api.bilibili.com 无特殊情况统一放在主站模块下，show.bilibili.com 统一放在会员购模块下等。

第二层级是文件夹。根据 b站api 划分，我们要求：主站api接口尽量全部采用文件夹层级，如 /x/space 路由下的api有且仅应存在于主站模块-空间文件夹下。

若是说明性文档（如接口调用注意事项，签名等）请合理使用接口描述及 新建 Markdown 功能。

接口状态

由于 Apifox 不支持自定义接口状态，所以我们约定接口状态如下：

开发中: 仍在完善的接口

测试中：已经完成接口文档编写，正在测试可用性

已发布：正常的接口

有异常：测试过程中发现根据文档无法正常请求的接口，需要修正

将废弃：不在正式环境使用但仍可用的接口

加入 Apifox 项目#

开始贡献#

API 分类问题#

接口状态#

加入 Apifox 项目

开始贡献

API 分类问题

接口状态