[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. 更新时间  ### 2. 更改信息 * 更新说明  * 新增接口  * 修改接口  * 删除接口  * 接口更名  ### 3. 更为细节的说明可以放在评论里  # 数据字典 ## 什么是数据字典 > 数据库表结构的图表展示 ## 如何创建数据字典 ### 1. 为文档添加`数据字典支持`   ### 2. 获取sql建表语句  ### 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; ```