发表于: 2019-11-22 21:20:21

1 1060


今天做了什么

 根据产品原型,前端后端相关人员一起,对照原型,根据模块及页面大概定义出接口 :


前台部分:

签到页面:

接口:

1.点击签到 put

2.获取用户信息 get

3.获取用户当月签到记录 get


学生证:

接口:

1.编辑用户信息 put

2.获取文章收藏列表 get

3.获取影像收藏列表 get

4.手机绑定 put

5.邮箱绑定 put

6.换绑手机号/邮箱 put


文学部:

接口:

1.获取文章列表 get

2.获取文章详情 get


影像部:

1.获取影像列表 get

2.获取影像详情 get


收获

看看接口设计的技巧:
原则一:必须符合Restful,统一返回格式,约定业务层错误码,每个编码可以携带可选的错误信息。
原则二:命名必须规范、优雅。
原则三:单一性。
单一性是指接口要做的事情应该是一个比较单一的事情,比如登陆接口,登陆完成应该只是返回登陆成功以后一些用户信息即可
原则四:可扩展。
扩展性是指我们的接口充分考虑客户端,想想他们是如何调用的,他要怎样使用我的代码,他会如何扩展我的代码,不要把过多的工作写在你的接口里面,而应该把更多的主动权交给客户程序员。
原则五:必须有标准的接口文档。
良好的接口设计,离不开清晰的接口文档表述。文档表述一定要足够详细
原则七:第三方服务接口数据尽量缓存。
原则八:第三方服务需要做降级

...


问题
明天的计划



返回列表 返回列表
评论

    分享到