接口设计原则(接口设计应包括)

网友投稿 517 2023-03-03


本篇文章给大家谈谈接口设计原则,以及接口设计应包括()对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。 今天给各位分享接口设计原则的知识,其中也会对接口设计应包括()进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!

本文目录一览:

C++接口设计原则

我觉的都有些问题接口设计原则,主要是以下两点接口设计原则
1 接口实现所需要用到的参数(a和b)一般不应该成为类的属性。
2 这样的设计使用户不能够面向接口编程接口设计原则,比如在调用seta(a)、setb(b)之前调用 add()的话程序就崩溃接口设计原则了。若在调用时不出现此情况用户就必须进到实现类里去查看细节接口设计原则,这违背了使用接口的原则。
其实这个接口就提供一个方法 int add(int a1,int b1) 就完事了 职责很单一

接口自动化测试脚本设计原则是什么?

说明:所谓的接口自动化测试脚本设计原则,主要是解决自动化脚本多次运行,数据库以存留上次数据问题或未存留依赖测试数据问题
原则:
1. 执行新增接口(如果没有,那么就使用sql语句就行先新增,获取新增数据)
2. 执行更新接口(更新新增的测试数据)
3. 查询接口(查询更新后的数据)
4. 删除接口(删除新增的数据,让数据库数据保持洁净性,如果没有删除接口,调用sql语句进行删除)
注意:以上脚本执行时,需要按照以上1~4执行顺序去执行。
提示:以上流程中有不清楚或疑问地方可以咨询黑马程序员官网要到相关资料。

接口设计评审规范

本接口设计规范,参考了restfull的部分设计理念。

资源是 Restful API 的核心元素,所有的操作都是针对特定资源进行的。

任何事物,只要有被引用到的必要,它就是一个资源。资源可以是实体(例如手机号码),也可以只是一个抽象概念(例如价值) 。下面是一些资源的例子:

Github 可以说是这方面的典范,下面我们就拿 repository 来说明。

我们可以看到几个特性:

接口名称应简单明了,望文知意,接口简介中,需描述清楚接口的具体业务功能。

原则上,接口命名规范整体采用“名词”+“动词”形式

接口返回或者操作的是单个资源对象,采用名称的单数形式命名,如:/user/add,/user/del,/user/get

接口返回或者操作的是多个资源对象,采用名称的复数形式命名,如:/users/get

针对同一个接口,根据实际业务需求,为解决接口兼容性问题,可以对接口进行版本扩展,命名规范为“名词”+“动词”+“版本号”形式,版本号采用v1、v2、v3形式命名

例:/user/login ,/user/login/v1

接口返回值,将统一采用如下格式:

{
"sign": "f64b967289ac4d8cbfdc22ad30ec9d09",
"content": "{}",
"timestamp": 1561204602005,
"desc": "成功!",
"code": "000",
"accessToken": "83BAED4DAE9DEF783FDE243F4B5C"
}

sign:返回值签名验签(如果需要)

如遇第三方合作等特殊情况,根据实际情况进行设计。

一个接口只做一件事情

连字符"-"一般用来分割URI中出现的字符串(单词),来提高URI的可读性,使用下划线"_"来分割字符串(单词)可能会和链接的样式冲突重叠,而影响阅读性。

根据RFC3986定义,URI是对大小写敏感的,所以为了避免歧义,我们尽量用小写字符。

例,针对金额,都统一为amount,而不是有的amount,有的money。

如是对老接口进行改动,需考虑接口的兼容性,包括字段的增减、字段名称调整、字段类型的调整、字段值内容长度的调整,字段值取值范围的调整等。

接口一旦发布就不易修改,要保持兼容性,拼写错误也不能改了,所以要仔细检查拼写。
著名悲剧:unix 的 creat。

creat是一个函数,可以用来创建一个文件并以只写的方式打开。

参数命名最好是定语+名词
比如 fileName, maxSize, textColor,而不是用name、size、colour

不要用生僻单词,也不要用汉语拼音

除非是约定俗成已经被广泛使用的缩写,否则老老实实用完整拼写。

比如 有open就要有close,有login就要有logout,这些单词基本是固定搭配的,使用者就很容易理解。

例,业务需要vip用户,接口不允许设计为isVipUser,而应该设计为获取用户的会员等级接口,/user/level/get,这样保证接口的通用性和扩展性

分页相关接口参数命名统一:

pageSize:每页记录条数

pageNum:当前页数

totalPageNum:总共页数

统一以分为单位进行传递

建议统一以时间毫秒数进行传递,避免前后端或者各种场景下日期格式不统一

通常在软件开发中设计模式都有哪些原则呢?

你好,很高兴能回答你的问题。

我们在软件开发中设计模式常用的的六大原则有下面几个:

1、开闭原则

开闭原则的意思是:对扩展开放,对修改关闭。在程序需要进行拓展的时候,不能去修改原有的代码,实现一个热插拔的效果。简言之,是为了使程序的扩展性好,易于维护和升级。想要达到这样的效果,我们需要使用接口和抽象类,后面的具体设计中我们会提到这点。

2、里氏代换原则

里氏代换原则是面向对象设计的基本原则之一。 里氏代换原则中说,任何基类可以出现的地方,子类一定可以出现。LSP 是继承复用的基石,只有当派生类可以替换掉基类,且软件单位的功能不受到影响时,基类才能真正被复用,而派生类也能够在基类的基础上增加新的行为。里氏代换原则是对开闭原则的补充。实现开闭原则的关键步骤就是抽象化,而基类与子类的继承关系就是抽象化的具体实现,所以里氏代换原则是对实现抽象化的具体步骤的规范。

3、依赖倒转原则

这个原则是开闭原则的基础,具体内容:针对接口编程,依赖于抽象而不依赖于具体。

4、接口隔离原则

这个原则的意思是:使用多个隔离的接口,比使用单个接口要好。它还有另外一个意思是:降低类之间的耦合度。由此可见,其实设计模式就是从大型软件架构出发、便于升级和维护的软件设计思想,它强调降低依赖,降低耦合。

5、迪米特法则,又称最少指导原则

最少指导原则是指:一个实体应当尽量少地与其他实体之间发生相互作用,使得系统功能模块相对独立。

6、合成复用原则

合成复用原则是指:尽量使用合成/聚合的方式,而不是使用继承。

关于接口设计原则和接口设计应包括()的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。 接口设计原则的介绍就聊到这里吧,感谢你花时间阅读本站内容,更多关于接口设计应包括()、接口设计原则的信息别忘了在本站进行查找喔。

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:股票开发接口api(股票交易接口api)
下一篇:java并发问题概述
相关文章

 发表评论

暂时没有评论,来抢沙发吧~