# 接口文檔
* * * * *
### 接口文檔首頁

這就是咱們的接口文檔首頁,雖然看起來很簡陋。。大道至簡嘛~ 嘿嘿。
左側為接口列表,白色背景部分為接口分組名稱,右側是文檔的介紹,下面是錯誤碼描述及列表,錯誤碼列表中的數據統一存儲在 api 模塊下的 error 目錄中,此處會通過反射自動列出錯誤碼的類 code 等。
* * * * *
### 接口詳情頁

上圖是修改密碼接口的詳情頁,因為每個接口的詳情頁字段都不同,這些跟具體業務邏輯有關,此處就不在一一講解,只列舉修改密碼的詳情頁講解。
左側上面已經介紹過了,咱們來介紹右側區域,左側最上方為 接口名稱,接口名稱下面為接口描述,右側為接口研發狀態,接著下面為請求地址與請求類型。
表格為請求參數,訪問 token 與 用戶 token 為接口附加字段,old_password 與 new_password 為業務需求字段。
訪問token 需要按指定規則與key 生成,用戶 token 需要從登陸接口獲取。
響應數據樣例下方可以看到 測試訪問token,此處是作者為了方便 終端工程師與大家測試才顯示出來的,若基于OneBase研發的產品, 在上線正式運營之前 此處務必要隱藏掉。
測試接口下方為在線調試功能,可以看到一些輸入框,輸入數據進去后點擊提交數據即可測試接口。
此文檔中的所有數據都可以在后臺接口管理中進行管理,是不是很方便丫 ^_^。
- 序言
- 基礎
- 安裝環境
- 安裝演示
- 規范
- 目錄
- 介紹
- 后臺介紹
- 后臺首頁
- 會員管理
- 系統管理
- 系統設置與配置管理
- 菜單管理
- 系統回收站
- 服務管理
- 插件管理
- 文章管理
- 接口管理
- 優化維護
- SEO管理
- 數據庫
- 文件清理
- 行為日志
- 執行記錄
- 統計分析
- 接口介紹
- 接口文檔
- 錯誤碼設計
- Token介紹
- 前臺介紹
- 架構
- 架構總覽
- 生命周期
- 入口文件
- 模塊設計
- 依賴注入
- 控制器架構
- 邏輯架構
- 驗證架構
- 服務架構
- 模型架構
- 行為架構
- 插件架構
- 配置
- 配置介紹
- 配置加載
- 配置擴展
- 請求
- 請求信息
- 日志
- 后臺行為日志
- 系統執行日志
- 框架日志
- 數據
- 數據庫設計
- 數據字典
- 數據庫操作
- 事務控制
- 混合操作
- 實戰
- 控制器
- 邏輯與驗證
- 視圖與模型
- 插件研發
- 服務研發
- 接口研發
- 雜項
- 數據導入導出
- 二維碼條形碼
- 郵件發送
- 云存儲服務
- 支付服務
- 短信服務
- 微信分享
- 生成海報
- 聊天室
- PJAX
- Demo
- Widget
- 附錄
- 常量參考
- 配置參考
- 函數參考
- 進階
- Redis
- 自動緩存
- 全自動緩存
- 索引
- 數據簽名
- 全自動事務
- 隊列