接口设计标准（接口的设计）

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

本文目录一览：

• 1、接口设计评审规范
• 2、哪位大神能提供下VISA国际通用接口安装标准，就是电视机壁挂设计标准，谢谢了
• 3、API 设计规范
• 4、java为什么要设计接口规范
• 5、ipad pro2020是什么接口
• 6、耳机接口定义

接口设计评审规范

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

统一以分为单位进行传递

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

哪位大神能提供下VISA国际通用接口安装标准，就是电视机壁挂设计标准，谢谢了

VISA国际通用接口安装标准，孔距尺寸（上下尺寸）分别有：75*75mm、100*100mm、200*150mm、200*200mm、275*275mm、430*275mm、400*350mm、400*400mm、450*330mm、740*450等尺寸及范围。

API 设计规范

设计时通过将请求和响应之间的不同部分隔离来让事情变得简单。保持简单的规则让接口设计标准我们能更关注在一些更大的更困难的问题上。

请求和响应将解决一个特定的资源或集合。使用路径（path）来表明身份接口设计标准，body来传输内容（content）还有头信息（header）来传递元数据（metadata）。查询参数同样可以用来传递头信息的内容接口设计标准，但头信息是首选，因为他们更灵活、更能传达不同的信息。

所有的访问API行为，都需要用TLS通过安全连接来访问。没有必要搞清或解释什么情况需要TLS 什么情况不需要TLS，直接强制任何访问都要通过 TLS。

理想状态下，通过拒绝所有非TLS请求，不响应http或80端口的请求以避免任何不安全的数据交换。如果现实情况中无法这样做，可以返回403 Forbidden响应。

把非TLS的请求重定向(Redirect)至TLS连接是不明智的，这种含混/不好的客户端行为不会带来明显好处。依赖于重定向的客户端访问不仅会导致双倍的服务器负载，还会使 TLS 加密失去意义，因为在首次非TLS调用时，敏感信息就已经暴露出去了。

制定版本并在版本之间平缓过渡对于设计和维护一套API是个巨大的挑战。所以，最好在设计之初就使用一些方法来预防可能会遇到的问题。

为了避免API的变动导致用户使用中产生意外结果或调用失败，最好强制要求所有访问都需要指定版本号。请避免提供默认版本号，一旦提供，日后想要修改它会相当困难。

最适合放置版本号的位置是头信息(HTTP Headers)，在 Accept 段中使用自定义类型(contenttype)与其他元数据(metadata)一起提交。例如:

在所有返回的响应中包含ETag头信息，用来标识资源的版本。这让用户对资源进行缓存处理成为可能，在后续的访问请求中把If-None-Match头信息设置为之前得到的ETag值，就可以侦测到已缓存的资源是否需要更新。

为每一个请求响应包含一个Request-Id头，并使用UUID作为该值。通过在客户端、服务器或任何支持服务上记录该值，它能为我们提供一种机制来跟踪、诊断和调试请求。

一个大的响应应该通过多个请求使用Range头信息来拆分，并指定如何取得。详细的请求和响应的头信息（header），状态码(status code)，范围(limit)，排序(ordering)和迭代(iteration)等，参考 Heroku PlatformAPI discussion of Ranges .

在 PUT/PATCH/POST 请求的正文（request bodies）中使用JSON格式数据，而不是使用form 表单形式的数据。这与我们使用JSON格式返回请求相对应，例如:

资源名 （Resource names）:使用复数形式为资源命名，除非这个资源在系统中是单例的 (例如，在大多数系统中，给定的用户帐户只有一个)。 这种方式保持了特定资源的统一性。

行为 （Actions）:好的末尾不需要为资源指定特殊的行为，但在特殊情况下，为某些资源指定行为却是必要的。为了描述清楚，在行为前加上一个标准的actions：

例如：

为了和域名命名规则保持一致，使用小写字母并用 - 分割路径名字，例如:

属性也使用小写字母，但是属性名要用下划线 _ 分割，以便在Javascript****中省略引号。例如：

在某些情况下，让用户提供ID去定位资源是不方便的。例如，一个用户想取得他在Heroku平台app信息，但是这个app的唯一标识是UUID。这种情况下，接口设计标准你应该支持接口通过名字和ID都能访问，例如:

不要只接受使用名字而放弃了使用id。

在一些有父路径/子路径嵌套关系的资源数据模块中，路径可能有非常深的嵌套关系，例如:

推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。在上述例子中，dyno属于app，app属于org可以表示为：

为每一次的响应返回合适的HTTP状态码。好的响应应该使用如下的状态码:

200: GET请求成功，及DELETE或PATCH同步请求完成，或者PUT同步更新一个已存在的资源;

201: POST同步请求完成，或者PUT同步创建一个新的资源;

202: POST，PUT，DELETE，或PATCH请求接收，将被异步处理;

206: GET 请求成功，但是只返回一部分;

使用身份认证（authentication）和授权（authorization）错误码时需要注意：

401 Unauthorized: 用户未认证，请求失败;

403 Forbidden: 用户无权限访问该资源，请求失败;

当用户请求错误时，提供合适的状态码可以提供额外的信息：

422 Unprocessable Entity: 请求被服务器正确解析，但是包含无效字段;

429 Too Many Requests: 因为访问频繁，你已经被限制访问，稍后重试;

500 Internal Server Error: 服务器错误，确认状态并报告问题.

对于用户错误和服务器错误情况状态码，参考： ** **HTTP response code spec

提供全部可显现的资源表述 (例如：这个对象的所有属性) ，当响应码为200或是201时返回所有可用资源，包含 PUT/PATCH和 DELETE 请求，例如:

当请求状态码为202时，不返回所有可用资源，例如：

在默认情况给每一个资源一个id属性。除非有更好的理由，否则请使用UUID。不要使用那种在服务器上或是资源中不是全局唯一的标识，尤其是自动增长的id。

生成小写的UUID格式 8-4-4-4-12，例如：

为资源提供默认的创建时间 created_at 和更新时间 updated_at，例如:

有些资源不需要使用时间戳那么就忽略这两个字段。

仅接受和返回UTC格式的时间。ISO8601格式的数据，例如:

使用嵌套对象序列化外键关联，例如:

而不是像这样:

这种方式尽可能的把相关联的资源信息内联在一起，而不用改变资源的结构，或者引入更多的顶层字段，例如:

响应错误的时，生成统一的、结构化的错误信息。包含一个机器可读的错误 id，一个人类可读的错误信息（message），根据情况可以添加一个url来告诉客户端关于这个错误的更多信息以及如何去解决它，例如:

文档化错误信息格式，以及客户端可能遇到的错误信息id。

客户端的访问速度限制可以维护服务器的良好状态，保证为其他客户端请求提供高性的服务。你可以使用 token bucket algorithm 技术量化请求限制。

为每一个带有RateLimit-Remaining响应头的请求，返回预留的请求tokens。

请求中多余的空格会增加响应大小，而且现在很多的HTTP客户端都会自己输出可读格式（"prettify"）的JSON。所以最好保证响应JSON最小化，例如：

而不是这样：

你可以提供可选的方式为客户端提供更详细可读的响应，使用查询参数（例如：?pretty=true）或者通过Accept头信息参数（例如：Accept:application/vnd.heroku+json;version=3; indent=4;）。

提供一个机器可读的模式来恰当的表现你的API。使用 prmd 管理你的模式，并且确保用prmd verify验证是有效的。

提供人类可读的文档让客户端开发人员可以理解你的API。

如果你用prmd创建了一个概要并且按上述要求描述，你可以为所有节点很容易的使用prmd doc生成Markdown文档。

除了节点信息，提供一个API概述信息:

提供可执行的示例让用户可以直接在终端里面看到API的调用情况，最大程度的让这些示例可以简单的使用，以减少用户尝试使用API的工作量。例如:

如果你使用 prmd 生成Markdown文档，每个节点都会自动获取一些示例。

描述您的API的稳定性或是它在各种各样节点环境中的完备性和稳定性，例如：加上原型版（prototype）/开发版（development）/产品版（production）等标记。

更多关于可能的稳定性和改变管理的方式，查看 ** **Heroku API compatibility policy

一旦你的API宣布产品正式版本及稳定版本时，不要在当前API版本中做一些不兼容的改变。如果你需要，请创建一个新的版本的API。

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的网易博客

ipad pro2020是什么接口

USB Type-C接口。

Type-A是电脑、电子配件中最广泛的接口标准，鼠标、U盘、数据线上大多都是此接口，体积也最大。Type-B一般用于打印机、扫描仪、USBHUB等外部USB设各。Type-C拥有比Type-A及Type-B均小得多的体积，是最新的USB接口外形标准，这种接口没有正反方向区别，可以随意插拔。

扩展资料

Type-C的优点

事实上，Type-C最直观的优势就是让你初底摆脱插线的烦恼，其先天出色的正反可插接口设计，不会再出现错插或者失误之后导致的部件受损情况。更重要的是，Type-C接口有着强大的兼容性，因此成为能够连接PC、游戏主机、智能手机、存储设备和拓展均等一切电子设备的标准化接口，并实现数据传输和供电的统一，例如将两台显示设备通过一条Type-C线紧密结合在一起使用。

除此之外，Type-C还支持USB3.1标准。该标准供电最大100W，电压和电流都会提高；降低了编码耗，从3.0的20%降低为3%。换句话说，用户能够迅速地通过Type-C传输数据和视频，或者更快地充电。该标准还可以让用户用自己的手机为其他设备充电。

参考资料来源：太平洋电脑网—苹果iPad Pro 2020(WLAN/11英寸)参数

耳机接口定义

耳机插座在我们日常生活中是比较常见的一种电子元件，其耳机插座的类型规格也区分有四段式耳机插座、三段式耳机插座等。三段式和四段式耳机的引脚定义如下：
 
四段式耳机插座接线的方法，其只是比一般三段式的耳机插座增加多了一个麦克风，一般三段式的耳机插座接线顺序为：左声道、右声道、地线。而对于四段式耳机插座来说，分分有两种不同的接法，一种是国标的接线顺序(从耳机插座最末端开始)为：左声道、右声道、麦克风、地线。另外一种是美标的接线顺序(从耳机插座接口最末端开始)为：左声道、右声道、地、麦克风 。
1.减少手机辐射：
作为音频行业的一名工作者，笔者同时也是一个多年使用蓝牙耳机的用户；拿通讯蓝牙耳机来说，它可以带给我的好处就有很多。我们都知道手机是有辐射的，这种辐射对于大脑来说当然不是什么好事，我们先不研究它能杀死多少脑细胞；单是举着手机打10分钟电话就足够让你的手臂酸痛，耳朵也很不舒服；相信这种感受大家都有过吧。而蓝牙耳机很好的解决了这个问题，它可以让我的大脑远离手机辐射，而且再也不用举着手机打电话，腰不酸背也不痛了，同时还减少了手机摔落的风险。
蓝牙耳机可有效减少辐射
2.保障人身安全：
开篇我们曾说过，随着新交通法的出台，开车时接打手机将被记录2分处罚；其实扣分不是有关部门的主要目的，是希望提醒驾驶员安全驾驶；而蓝牙耳机在新交通法出台后变得异常火爆，购买它的大部分人都是有车一族。笔者的亲身体会是，使用蓝牙耳机后，我在开车时不用再单手握方向盘接打电话了，注意力会更加集中，车开的自然也更稳啦；当然还不用担心被扣分哈。
接打电话方便 可以让你更安全的驾驶
3.释放双手：
除了开车，笔者在平时的生活和工作中也会经常配戴蓝牙耳机，其实现在的蓝牙耳机在舒适度方面已经做的不错，柔软的硅胶耳塞让我的耳朵不再疼痛；由于我平时在家里习惯把手机随处扔，因此在我上厕所、干家务活、玩电脑和偶尔做饭时，都会戴着蓝牙耳机，因为它可以释放我的双手，同时不会漏接任何一个电话（尤其是老婆的电话，你懂的）。而在日常工作中，我有时也会配戴蓝牙耳机，因为这样我就可以一边做手上的工作一边接打电话，两不耽误。 关于接口设计标准和接口的设计的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 接口设计标准的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于接口的设计、接口设计标准的信息别忘了在本站进行查找喔。

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