api接口设计工具（api 设计）

本文目录一览：

• 1、如何设计出一些优雅的API接口

• 2、想问一下什么是API接口，具体是什么意思

• 3、API到底是什么？

• 4、如何设计API接口，请求接口时需要进行身份验证，防止第三方随意调用接口？

• 5、现在很多平台都提供有API接口，我自己的软件能不能设计一个API接口来和多个平台的API接口对接？

如何设计出一些优雅的API接口

1. 拼写要准确

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

著名悲剧：unix 的 creat

2. 不仅是英文单词不要拼错，时态也不要错。

比如：

返回bool的判断函数，单数要用 is 复数要用are，这样你的命名就和文档中的描述保持了一致性。

表示状态的变量或者函数要注意时态，比如 onXxxxChanged 表示xxx已经变化了，isConnecting表示正在连接。

正确的时态可以给使用者传递更丰富的信息。

3. 函数最好是动宾结构

动宾结构就是  doSomething，这样的函数命名含义明确

比如： openFile, allocBuffer, setName

如果这个函数的动词宾语就是这个对象本身，那么可以省略掉宾语

4. 属性命名最好是定语+名词

比如 fileName, maxSize, textColor

5. 不要用生僻单词，这不是秀英语的地方，也不要用汉语拼音

比如：rendezvous，估计大多数人要去查词典才知道什么意思，这个词源自法语，是约会的意思。

Symbian OS里有个用它命名的函数，开发Symbian的是英国人，也许人家觉得很平常吧，反正我是查了词典才知道的。

6. 不要自己发明缩写

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

坏例子:  count-cnt, manager-mngr password-pw button-btn

现代的IDE都有很好的自动完成功能，名字长一点没关系的，可读性更重要。

7. 保持方法的对称性，有些方法一旦出现就应该是成对的，

比如 有open就要有close，有alloc就要有free，有add就要有remove，这些单词基本是固定搭配的，使用者就很容易理解。

如果 open对应clear就有点让人困惑了。

想问一下什么是API接口，具体是什么意思

API接口：

API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。

API函数包含在Windows系统目录下的动态连接库文件中。Windows API是一套用来控制Windows的各个部件的外观和行为的预先定义的Windows函数。

在linux中，用户编程接口API遵循了UNIX中最流行的应用编程界面标准---POSIX标准。POSIX标准是由IEEE和ISO/IEC共同开发的标准系统。

扩展资料：

API的程序功能：

远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。

标准查询语言（SQL）：是标准的访问数据的查询语言，通过通用数据库实现应用程序间的数据共享。

文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。

信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。

当前应用于 API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。

参考资料来源：百度百科-api （应用程序编程接口）

API到底是什么？

API，全称Application Programming Interface，即应用程序编程接口。

API是一些预先定义函数，目的是用来提供应用程序与开发人员基于某软件或者某硬件得以访问一组例程的能力，并且无需访问源码或无需理解内部工作机制细节。

API就是操作系统给应用程序的调用接口，应用程序通过调用操作系统的 API而使操作系统去执行应用程序的命令（动作）。在 Windows 中，系统API是以函数调用的方式提供的。

SDA和API

可以认为API是包含在SDK中的：SDK是一系列文件的组合，包括lib、dll、.h、文档、示例等；API是对程序而言的，提供用户编程时的接口，即一系列模块化的类和函数。

API与GUI

两者都属于直接用户接口，不同的是API接口属于一种操作系统或程序接口，但是GUI接口属于一种图形操作系统。

扩展资料：

API分类

1.Windows API：Windows application programming interface（WIndows应用程序接口）

Windows安装完，系统就有了一套简单的SDK，包含了一套完整的基础Windows API，如果安装VC或下载新的SDK后，就可以使用更加丰富的Windows API了。

凡是在 Windows工作环境底下执行的应用程序，都可以调用Windows API。

2.linux API：linux application programming interface（linux应用程序接口）

在linux中，用户编程接口API遵循了UNIX中最流行的应用编程界面标准——POSIX标准。

参考资料来源：

百度百科-api（应用程序编程接口）

百度百科-SDK/API

如何设计API接口，请求接口时需要进行身份验证，防止第三方随意调用接口？

1. 设定一个密钥比如key = ‘2323dsfadfewrasa3434'。

2. 这个key 只有发送方和接收方知道。

3. 调用时，发送方，组合各个参数用密钥 key按照一定的规则(各种排序，MD5，ip等)生成一个access_key。一起post提交到API接口。

4. 接收方拿到post过来的参数以及这个access_key。也和发送一样，用密钥key 对各个参数进行一样的规则(各种排序，MD5，ip等)也生成一个access_key2。

5. 对比access_key 和access_key2 。一样。则允许操作，不一样，报错返回或者加入黑名单。

现在很多平台都提供有API接口，我自己的软件能不能设计一个API接口来和多个平台的API接口对接？

API通用接口，给软件预留的外部连接接口，是按照自己的一套规则体系设计的接口，由于各软件设计的规则和应用条件不同，基本上是不可能你一个API接口就能对接多个平台的。尤其是百度、360这样的大公司，只能是你按照他们的规则要求去做设计去适应他们的要求！

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