# 接口文档
* * * * *
### 接口文档首页
![](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研发的产品, 在上线正式运营之前 此处务必要隐藏掉。
测试接口下方为在线调试功能,可以看到一些输入框,输入数据进去后点击提交数据即可测试接口。
此文档中的所有数据都可以在后台接口管理中进行管理,是不是很方便丫 ^_^。
- 序言
- 基础
- 安装环境
- 安装演示
- 规范
- 目录
- 介绍
- 后台介绍
- 后台首页
- 会员管理
- 系统管理
- 系统设置与配置管理
- 菜单管理
- 系统回收站
- 服务管理
- 插件管理
- 文章管理
- 接口管理
- 优化维护
- SEO管理
- 数据库
- 文件清理
- 行为日志
- 执行记录
- 统计分析
- 接口介绍
- 接口文档
- 错误码设计
- Token介绍
- 前台介绍
- 架构
- 架构总览
- 生命周期
- 入口文件
- 模块设计
- 依赖注入
- 控制器架构
- 逻辑架构
- 验证架构
- 服务架构
- 模型架构
- 行为架构
- 插件架构
- 配置
- 配置介绍
- 配置加载
- 配置扩展
- 请求
- 请求信息
- 日志
- 后台行为日志
- 系统执行日志
- 框架日志
- 数据
- 数据库设计
- 数据字典
- 数据库操作
- 事务控制
- 混合操作
- 实战
- 控制器
- 逻辑与验证
- 视图与模型
- 插件研发
- 服务研发
- 接口研发
- 杂项
- 数据导入导出
- 二维码条形码
- 邮件发送
- 云存储服务
- 支付服务
- 短信服务
- 微信分享
- 生成海报
- 聊天室
- PJAX
- Demo
- Widget
- 附录
- 常量参考
- 配置参考
- 函数参考
- 进阶
- Redis
- 自动缓存
- 全自动缓存
- 索引
- 数据签名
- 全自动事务
- 队列