软件接口设计规范（软件接口设计标准）

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

本文目录一览：

• 1、什么是软件接口规约？请给个具体的例子说明！
• 2、接口设计评审规范
• 3、java为什么要设计接口规范
• 4、怎么用替换功能将文档内容自然分段(每个制表符替换为一个段落标记)？
• 5、软件设计中的接口设计指的是实用性设计还是运行环境设计呢?
• 6、软件设计说明书应该怎么写？

什么是软件接口规约？请给个具体的例子说明！

简单软件接口设计规范的说应该就是API规范
很多软件会提供程序接口出来软件接口设计规范，举个例子
比如说我们用的浏览器IE本身就是一个软件，它会公布比如说mouseover这个接口出来
当编程人员在mouseover里写入代码也就代表当用户鼠标划过这个网页的时候会做出什么响应
比如说我们在某些做的比较炫的网站看到鼠标走到哪都有一串星星跟随
而mouseover这个接口的规定里会写，有哪些参数（参数类型，范围值等）可以使用，这个接口有哪些事件可以响应等等

接口设计评审规范

本接口设计规范，参考软件接口设计规范了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:总共页数

统一以分为单位进行传递

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

java为什么要设计接口规范

抽象类和接口
什么是接口：接口就是一些方法特征的集合------接口是对抽象的抽象。
什么是抽象类：抽象类对某具体类型的部分实现------抽象类是对具体的抽象。
方法特征包括：方法的名字、参数的数目、参数的类型。不包括：返回类型、参数名字、和抛出的异常。
接口是类型转换的前提、是动态调用的保证。实现某一接口就完成了类型的转换（多重继承）软件接口设计规范；动态调用只关心类型，不关心具体类。
       --------------------------------------------------------------------------------------------------------------------------------------
       JAVA接口（抽象类）用来声明一个新的类型。
JAVA设计师应当主要使用接口和抽象类将软件单位与内部和外部耦合起来。
换言之，应当使用JAVA接口和抽象类而不是具体类进行变量的类型声明、参数的类型声明、方法的返回类型声明、以及数据类型的转换等。
当然一个更好的做法是仅仅使用接口，而不是抽象类来做上面这些事情。
在理想的情况下，一个具体类应当只实现接口和抽象类中声明的方法，而不应当给出多余的方法！
接口和抽象类一般作为一个类型等级结构的起点。
接口比抽象类更为抽象所以优先使用接口声明抽象类型！
--------------------------------------------------------------------------------------------------------------------------------------
抽象类和接口
       抽象类仅提供一个类的部分实现。抽象类可以有实例变量、以及一个或多个构造函数。抽象类可以同时又抽象方法和具体方法。
       一个抽象类不会有实例，它的构造函数不能被客户端用来创建实例。一个抽象类的构造函数可以被其子类调用，从而使一个抽象类的所有子类可以有一些共同的实现，而不同的子类可以在此基础上有不同的实现。
接口比抽象类更为抽象所以有线使用接口声明抽象类！
抽象类是用来继承的。（具体类不是用来继承的，“只要有可能不要从具体类继承---SCOTT MERYES”）。
抽象类设计原则：
1.          抽象类应当拥有尽可能多的代码！（公用方法）。代码集中于抽象的方向。
2.          抽象类应当拥有尽可能少的数据！（公共属性）。数据集中于具体的方向。
继承复用的使用条件------- PETER COAD条件
1.        子类是超类的一个特殊种类而不是超类的一个角色！正确区分“HAS-A”“IS-A”的关系。
2.        子类之间不应发生替换！？
3.        子类具有扩展超类的责任，而不是置换（OVERRIDE）掉或注销（NULLIFY）掉的责任。
4.        只有在分类学角度上有意义时才可以使用继承，不要从具体类继承。
接口和抽象类的区别：
    1.       抽象类可以提供某些方法的实现。如果向抽象类中加入一个新的具体的方法，那么所有的子类一下子就得到了这个方法。接口做不到这一点！（这也许是抽象类的唯一优点）。
2.      因JAVA的单根结构限制，只类只能实现一个抽象类类型，而接口类型这无此限制。这使抽象类作为类型定义工具的效能落后于接口。接口是定义混合类型（实现多从继承）的理想工具：用一个
3.      从代码重构的角度上讲，将一个具体类重构成一个接口的实现是很容易的。

文章来自 haoyu1566的网易博客

怎么用替换功能将文档内容自然分段(每个制表符替换为一个段落标记)？

替换功能，将文档内容自然分段，每个指标服务替换为一个段落标记的话，直接在更多格式里面进行替换。

计算机用语：

文件的另一种称呼，一般将WORD，EXCEL等文字编辑软件产生的文件叫做文档。

这样说不够精确，文件，文件夹，与文档，三个的关系是不同，但又有相同的地方，所以，要阐述准确，要表达三者的含义与联系。

扩展资料：

软件设计说明书的框架和内容如下：

（1）概述。描述设计工作总的范围，包括系统目标、功能、接口等。

（2）系统结构。用软件结构图说明本系统的模块划分，扼要说明每个模块的功能，按层次给出各模块之间的控制关系。

（3）数据结构及数据库设计。对整个系统使用的数据结构及数据库进行设计，包括概念结构设计、逻辑结构设计和物理设计。用相应的图形和表格把设计结果描述出来。

（4）接口设计。设计人机界面，说明向用户提供的命令以及系统的返回信息；设计外部接口，说明本系统与外界的所有接口信息，包括软件与硬件之间的接口、本系统与支持软件之间的接口关系。

参考资料来源：百度百科-文档

软件设计中的接口设计指的是实用性设计还是运行环境设计呢?

架构中的接口设计主要事指系统间的交互规则定义，主要包括接口的格式，类型，长度等，以及规范标准，接口有很多种级别，文件接口，数据接口，应用接口，在软件设计的每一层之间都存在接口。（所谓的实用性接口）
而在软件设计系统内的接口设计主要根据面向对象方法的需要，对现实概念进行抽象和简单化的过程，接口设计要秉持单一职责原则，将概念最小化，保证接口设计能够满足开闭原则，接口一旦定义则避免修改，而这个能力完全取决于设计师抽象的功力。

软件设计说明书应该怎么写？

软件设计说明书编写规范
一、 编写目的
二、 应用文档
三、 要求及内容
2.1 编写格式要求
2.2 说明书内容
2.2.1 说明书目的
2.2.2 参考资料及文档
2.2.3 设计原则
2.2.4 接口描述
2.2.5 功能描述
2.2.6 接口协议
2.2.7 编程协定
2.2.8 数据结构
2.2.9 逻辑结构
2.2.10 程序流程
2.2.11 源文件列表
2.2.12 其他
2.3 文档修订历史
四、 编写文档注意事项
五、 样例及模板文档 关于软件接口设计规范和软件接口设计标准的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 软件接口设计规范的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于软件接口设计标准、软件接口设计规范的信息别忘了在本站进行查找喔。

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