# 接口管理
* * * * *
### 接口列表
接口分組管理這里就不在敘述,就是為了給接口歸類。

上圖為接口列表頁,左上角有兩個按鈕,一個是新增接口,一個是接口文檔跳轉按鈕。
數據列表中 第1列為 接口名稱,第2列為接口分組,第3列為接口請求類型,OneBase默認統一POST類型,當然需要其他類型如GET 可自行擴展,第4列為接口地址也就是 (控制器/方法),第5列是接口目前的狀態,接口狀態中的選項在系統設置的API欄目下可進行配置,第6列為研發者,研發者成員也在系統設置的API欄目下配置,后面兩列為接口排序與操作,接口排序為同級有效。
* * * * *
### 接口新增

^_^。 雖然表單數據數據有點多,但是不要怕蛤,咱們來一個一個講解。
咱們按從左往右,從上往下進行編號講解,比如 1 2 3 4 對應的是 接口名稱,接口排序值,請求地址,請求類型。
1:API接口名稱,就是用來看滴。。
2:接口排序值,用來進行接口顯示排序,這些都很好理解啦。
3:請求地址,接口訪問地址格式(控制器/方法)。
4:請求類型,默認為POST,需要其他類型可自己擴展。
5:是否為分頁接口,意思就是這個接口是否需要分頁功能,如果需要分頁功能可傳遞相關參數,如:list_rows 每頁顯示的數據量,page 查詢的頁碼。
6:研發者,此接口的研發人員,選項中的可選值可在系統設置的API分組下進行配置。
7:請求數據,意思就是執行此接口是否需要帶請求參數,默認為否不帶請求數據,此處的請求數據控制的為接口所依賴的請求參數,大家可以打開 https://onebase.org/api.php 看到里面這些接口 下面有個測試接口功能,此處測試接口功能的表單就是根據這里請求數據設置自動生成的,Token與分頁參數是不受此處控制的。
8:響應數據,意思就是接口執行成功后返回的數據,默認為否不帶返回數據,為是 則可添加接口返回的數據,當然也會有特殊數據 如 分頁數據及后面將介紹的數據簽名 等。
9:接口分組,這個就不介紹啦。
10:接口狀態,這個也飄過吧。
11:接口響應示例,這個是用來給接口調用者看的,方便接口調用者可一眼看清數據結構,提升團隊研發效率。
12:接口簡介,用來看滴。
13:是否驗證用戶令牌:user_token, 用來做身份驗證滴,比如 文章列表接口,所有的訪問者不需要登錄也可以看到,就設置為否,這樣接口調用就不需要帶user_token,若 為需要身份驗證的接口,如 訂單列表,某個會員只能查看自己的訂單,就需要用到user_token啦,所以 像 訂單管理,個人中心等 這些接口是需要帶 user_token的。user_token 是調用登錄接口后返回的,所以若終端想調用需要身份驗證的接口,則需要 先調用登錄接口后將接口中返回的 user_token 保存下來,在后續接口調用過程中使用。
14:是否響應數據簽名:data_sign,此處是用于做數據安全驗證的,比如咱們服務器給終端返回了數據,但是 終端那邊怎么知道真滴是咱們返回的呢。。此時 data_sign 就派上用場啦。 返回的數據中帶上了 data_sign 字段,終端根據服務器返回的數據進行與服務器端相同的算法,計算出 終端的 data_sign,然后兩端的 data_sign 進行比對,若一模一樣,則說明 數據是一模一樣滴,這樣就很安全啦,別人想改也不行,嘿嘿。
15:是否驗證請求數據簽名:data_sign,原理是一樣滴,意思就是 終端像接口提交數據時,咱們服務器端也得知道提交的數據是否安全,所以 咱們也要根據提交上來的數據 生成 data_sign,與提交數據中帶的data_sign,進行比對,不一樣的話就不執行操作,接口返回數據簽名不對,一樣的話就放行。
16:這個是備用的。。擔心服務端人員太膩害,研發出來的接口實在是用言語無法表達。。就可以用富文本進行圖文描述。。
好啦,輸入選項介紹完了,咱們看下登錄接口的編輯數據頁面,看看是咋輸入滴。

后臺接口管理功能就介紹到這里,更深一步將在接口研發中講解。
- 序言
- 基礎
- 安裝環境
- 安裝演示
- 規范
- 目錄
- 介紹
- 后臺介紹
- 后臺首頁
- 會員管理
- 系統管理
- 系統設置與配置管理
- 菜單管理
- 系統回收站
- 服務管理
- 插件管理
- 文章管理
- 接口管理
- 優化維護
- SEO管理
- 數據庫
- 文件清理
- 行為日志
- 執行記錄
- 統計分析
- 接口介紹
- 接口文檔
- 錯誤碼設計
- Token介紹
- 前臺介紹
- 架構
- 架構總覽
- 生命周期
- 入口文件
- 模塊設計
- 依賴注入
- 控制器架構
- 邏輯架構
- 驗證架構
- 服務架構
- 模型架構
- 行為架構
- 插件架構
- 配置
- 配置介紹
- 配置加載
- 配置擴展
- 請求
- 請求信息
- 日志
- 后臺行為日志
- 系統執行日志
- 框架日志
- 數據
- 數據庫設計
- 數據字典
- 數據庫操作
- 事務控制
- 混合操作
- 實戰
- 控制器
- 邏輯與驗證
- 視圖與模型
- 插件研發
- 服務研發
- 接口研發
- 雜項
- 數據導入導出
- 二維碼條形碼
- 郵件發送
- 云存儲服務
- 支付服務
- 短信服務
- 微信分享
- 生成海報
- 聊天室
- PJAX
- Demo
- Widget
- 附錄
- 常量參考
- 配置參考
- 函數參考
- 進階
- Redis
- 自動緩存
- 全自動緩存
- 索引
- 數據簽名
- 全自動事務
- 隊列