快捷搜索:

设计好和坏的准则是什么

2019-10-08 作者:2019精准正版资料   |   浏览(51)

大家好,我是IT修真院北京分院第22期的学员杨舜,一枚正直纯洁善良的JAVA程序员

今天给大家分享一下,修真院官网JAVA任务2的深度思考:一份规范的接口文档应该包括什么内容,衡量接口设计好和坏的准则是什么?

PPT链接:点我!

_腾讯视频

什么是接口文档?

在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。

为什么要写接口文档?

1、项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发

2、项目维护中或者项目人员更迭,方便后期人员查看、维护

接口规范是什么?

首先接口分为四部分:方法、uri、请求参数、返回参数

1、方法:新增 修改 删除 获取

2、uri:以/a开头,如果需要登录才能调用的接口(如新增、修改;前台的用户个人信息,资金信息等)后面需要加/u,即:/a/u;中间一般放表名或者能表达这个接口的单词;

get方法,如果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以/list结尾

3、请求参数和返回参数,都分为5列:字段、说明、类型、备注、是否必填

字段是类的属性;

说明是中文释义;

类型是属性类型,只有String、Number、Object、Array四种类型;

备注是一些解释,或者可以写一下例子,比如负责json结构的情况,最好写上例子,好让前端能更好理解;

是否必填是字段的是否必填。

4、返回参数结构有几种情况:

1、如果只返回接口调用成功还是失败(如新增、删除、修改等),则只有一个结构体:code和message两个参数;

2、如果要返回某些参数,则有两个结构体:1是code/mesage/data,2是data里写返回的参数,data是object类型;

3、如果要返回列表,那么有三个结构体,1是code/mesage/data,data是object,里面放置page/size/total/list 4个参数,其中list是Arrary类型,list里放object,object里是具体的参数。

衡量接口设计好和坏的准则是什么?

单词拼写要准确,接口一旦发布就不能改了,要保持兼容性,拼写错误也不能改了,所以要仔细检查拼写,否则会被同行嘲笑很多年。

方法名称是否可以自描述,即看到方法的名字就能知道方法的作用、看到参数名就知道需要传递什么样的数据(比如getUserById(String userId))

API一定要便于使用者理解,这样才是广泛传播的基础。如果有些API需要用户掌握特定的概念、定义,那么就要保持这个API的一致性,不能轻易的改变API,否则会给使用者带来很大的麻烦。

接口参数验证必不可少,同时异常等返回信息得全面,让调用者明确异常原由;


今天的分享就到这里啦,欢迎大家点赞、转发、留言、拍砖~

下期预告:nginx如何实现负载均衡?不见不散~

技能树.IT修真院

“我们相信人人都可以成为一个工程师,现在开始,找个师兄,带你入门,掌控自己学习的节奏,学习的路上不再迷茫”。

这里是技能树.IT修真院,成千上万的师兄在这里找到了自己的学习路线,学习透明化,成长可见化,师兄1对1免费指导。快来与我一起学习吧~

我的邀请码:10691076,或者你可以直接点击此链接:www.jnshu.com/login/1/10691076

本文由正版香港马报免费资料发布于2019精准正版资料,转载请注明出处:设计好和坏的准则是什么

关键词: