# 接口文档 * * * * * ### 接口文档首页 ![](https://box.kancloud.cn/732f9a53f296d22fd82a51ce892c2511_1917x839.png) 这就是咱们的接口文档首页,虽然看起来很简陋。。大道至简嘛~ 嘿嘿。 左侧为接口列表,白色背景部分为接口分组名称,右侧是文档的介绍,下面是错误码描述及列表,错误码列表中的数据统一存储在 api 模块下的 error 目录中,此处会通过反射自动列出错误码的类 code 等。 * * * * * ### 接口详情页 ![](https://box.kancloud.cn/f54f5dbdac579a37f8768346e72f1c2b_1894x1000.png) 上图是修改密码接口的详情页,因为每个接口的详情页字段都不同,这些跟具体业务逻辑有关,此处就不在一一讲解,只列举修改密码的详情页讲解。 左侧上面已经介绍过了,咱们来介绍右侧区域,左侧最上方为 接口名称,接口名称下面为接口描述,右侧为接口研发状态,接着下面为请求地址与请求类型。 表格为请求参数,访问 token 与 用户 token 为接口附加字段,old_password 与 new_password 为业务需求字段。 访问token 需要按指定规则与key 生成,用户 token 需要从登陆接口获取。 响应数据样例下方可以看到 测试访问token,此处是作者为了方便 终端工程师与大家测试才显示出来的,若基于OneBase研发的产品, 在上线正式运营之前 此处务必要隐藏掉。 测试接口下方为在线调试功能,可以看到一些输入框,输入数据进去后点击提交数据即可测试接口。 此文档中的所有数据都可以在后台接口管理中进行管理,是不是很方便丫 ^_^。