接口管理平臺的基本元素 · 接口文檔管理系統

[toc=2] # 接口文檔目錄 ## 接口目錄的作用 1. 對文檔結構有更直觀的理解(無序列表) 1. 方便文檔跳轉(超鏈接) >[danger] 本質上, 就是`無序列表` + `超鏈接` ## 如何編寫目錄 * 看云幫助 ==> [操作目錄](https://help.kancloud.cn/41499) ```markdown * [數據字典](data_doc.md) * [用戶接口](first_11.md) * [用戶注冊](userRegister.md) * [用戶登錄](userLogin.md) * [獲取驗證碼](getCode.md) * [上傳用戶頭像](uploadHeadImg.md) * [更改密碼](changePassword.md) * [用戶信息](userInfo.md) * [費用接口](first_22.md) * [微信充值(完善中...)](weiXinCharge.md) * [微信交押金(完善中...)](weiXinDeposit.md) * [微信退押金(完善中...)](weiXinReturn.md) * [支付寶充值(完善中...)](aLiCharge.md) * [支付寶交押金(完善中...)](aLiDeposit.md) * [支付寶退押金(完善中...)](aLiReturn.md) * [查詢余額](getRemnantMoney.md) * [交易明細/消費記錄](tradeRecord.md) * [交易明細/充值記錄](chargeRecord.md) ``` # 更新信息 ## 更新信息應該包含哪些內容 ### 1. 更新時間 ![](https://box.kancloud.cn/570619eee6313fede82d1596e5523a2b_794x570.png) ### 2. 更改信息 * 更新說明 ![](https://box.kancloud.cn/f48118d23d510d05889f8d3b4ed3a008_988x223.png) * 新增接口 ![](https://box.kancloud.cn/f91a9ecee3189a2dd76b18c0a0d35d91_850x216.png) * 修改接口 ![](https://box.kancloud.cn/3441d719c9aa6982b5831cedd57b65d4_757x275.png) * 刪除接口 ![](https://box.kancloud.cn/767c37844ff7082bbb2bfe5a435f83e6_711x234.png) * 接口更名 ![](https://box.kancloud.cn/fbafd9e8cabf89ff679d1df9f916408c_877x545.png) ### 3. 更為細節的說明可以放在評論里 ![](https://box.kancloud.cn/e415e7147b993dc157586d3954567895_1002x402.png) # 數據字典 ## 什么是數據字典 > 數據庫表結構的圖表展示 ## 如何創建數據字典 ### 1. 為文檔添加`數據字典支持` ![](https://box.kancloud.cn/7336c4190debb495fa6991462047f5be_209x270.png) ![](https://box.kancloud.cn/831b84f54236ca6f146b649611893e97_800x555.png) ### 2. 獲取sql建表語句 ![](https://box.kancloud.cn/c55a0882540c7ca25d72153fcbc09d57_880x470.png) ### 3. 加上```[sql] ``` ```[sql] CREATE TABLE `zknu_user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `name` varchar(32) DEFAULT '', `password` varchar(32) DEFAULT NULL, `auth` tinyint(4) DEFAULT '0' COMMENT '權限', `vehicles` varchar(1024) DEFAULT '' COMMENT '用戶擁有的車輛id集合 ', `money` int(32) DEFAULT '0' COMMENT '用戶充值', `phone` varchar(32) DEFAULT '' COMMENT '客戶電話', `identity` varchar(64) DEFAULT '' COMMENT '身份證號', `photo` varchar(64) DEFAULT '' COMMENT '頭像名稱', `deposited` tinyint(1) NOT NULL DEFAULT '0' COMMENT '是否交押金 1:yes 0:no', `ownerid` int(11) DEFAULT NULL, `masterid` int(11) DEFAULT NULL COMMENT '標記主卡id', `familys` varchar(1024) DEFAULT '' COMMENT '保存主用戶的所有副卡用戶，也就是家庭成員', `bindTime` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '主卡為副卡綁定時的時間', PRIMARY KEY (`id`) ) ENGINE=MyISAM AUTO_INCREMENT=23 DEFAULT CHARSET=utf8; ``` ``` ### 4. 得到數據詞典 ```[sql] CREATE TABLE `zknu_user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `name` varchar(32) DEFAULT '', `password` varchar(32) DEFAULT NULL, `auth` tinyint(4) DEFAULT '0' COMMENT '權限', `vehicles` varchar(1024) DEFAULT '' COMMENT '用戶擁有的車輛id集合 ', `money` int(32) DEFAULT '0' COMMENT '用戶充值', `phone` varchar(32) DEFAULT '' COMMENT '客戶電話', `identity` varchar(64) DEFAULT '' COMMENT '身份證號', `photo` varchar(64) DEFAULT '' COMMENT '頭像名稱', `deposited` tinyint(1) NOT NULL DEFAULT '0' COMMENT '是否交押金 1:yes 0:no', `ownerid` int(11) DEFAULT NULL, `masterid` int(11) DEFAULT NULL COMMENT '標記主卡id', `familys` varchar(1024) DEFAULT '' COMMENT '保存主用戶的所有副卡用戶，也就是家庭成員', `bindTime` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '主卡為副卡綁定時的時間', PRIMARY KEY (`id`) ) ENGINE=MyISAM AUTO_INCREMENT=23 DEFAULT CHARSET=utf8; ```