发表于： 2017-06-17 23:33:37
1 1199
今天完成的事情：
DB设计大体完成，还有一些标签字段的问题，跟严恒讨论了一下，还没有讨论出个结果来。。。
昨天就试着写接口文档，发现根本不是像想象中的那么好写，其中需要考虑到很多东西。
1.字段类型：id，create_at,create_by,update_at,update_by 都设为bigint用默认长度即可，非空
2.约定的类型，用int，如果是状态，一般用0/1，就用 int(1),如果是比较多的约定，数字间隔开，用int(2)，以够用且尽可能小为准
3.默认值：默认的上下架状态
4.MOCK value写假数据
接口里面需要写：
1.复杂的sql语句（模糊查询，多表查询，子查询）
2.代码的实现逻辑
如果是接口变动：要在前一期的接口文档后面继续写，新增改动的部分标红
接口文档：
1.url
get/post/put/delete
get /a/u/project/search
/a/表示：
/u/表示：需要登录才能访问的接口 /project/表示 ：模块名
/search表示 ：搜索列表，注意，不用list
a.url没有参数：url：get/a/component/search
b.url有一个参数：url:get/a/u/component/{id}
c.url有两个参数：url:put/a/u/component/status/{status}/{id}
d.多个参数：请求参数里传
2.字段
和数据库的字段略有不同
①大小写
②数据库的一个字段对应接口文档的两个字段
3.类型
Number：Integer/Long/Flout/Double
String: Charactor/String
Object : 对象
Array :数组
4.说明
字段的含义 ：比如id是指的项目id还是产品id
5.备注
单独说明
进参出参
1.code:状态码
2.message：返回的消息
3.data:数据
明天计划的事情：
试着完成接口文档，真的很难写。。。
遇到的问题：
上面提到了。
收获：
之前设计DB的时候，感觉表还是比较好写的，写起接口来，发现很多问题出来，老大之前说设计DB做方案设计需要20%~30%项目开发的时间，果然如此，向我们这种新手感觉时间更加长。希望这两天能把方案设计做出来吧，奶自己一波。
返回列表
评论