api接口管理规范（软件接口规范文档）

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

本文目录一览：

• 1、restful api接口规范
• 2、API接口规范
• 3、API接口响应格式规范定义
• 4、API_接口测试规范
• 5、api接口程序的管理方式
• 6、vue入门：对vue项目中api接口的封装管理

restful api接口规范

restful api接口规范如下：

1、协议

API与用户的通信协议，总是使用HTTPs协议。

2、域名

应该尽量将API部署在专用域名之下。

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

3、版本（Versioning）

应该将API的版本号放入URL。

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

4、路径（Endpoint）

路径又称"终点"（endpoint），表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

API接口规范

一、协议

二、域名

三、版本控制

四、路径规则

五、请求方式

六、过滤信息

七、传入参数

八、响应参数

九、非RESTful API的需求

十、一致性原则

十一、接口文档

API接口响应格式规范定义

由于接口规范的定义和接口的实际实现是分开的两个部分, 而且涉及到多人协作, 因此在开发过程中可能出现接口规范与实现不同步, 最终造成实际的接口不符合规范的定义, 接口规范就会慢慢失去存在的意义.

为api接口管理规范了尽量避免这种问题, 后端在实现接口的过程中应该确保与接口规范保持一致, 一旦出现分歧, 必须同步修改接口规范, 尽可能保持沟通.

专门的api应用使用独立域名 https://api.example.com
简单的可使用api前缀区分 https://www.example.com/api

接口版本的控制，可以在程序发布时，不同版本的业务逻辑在一定程度上避免受到影响。

https://api.example.com/v {n}
应该将API的版本号放入URL。
采用多版本并存，增量发布的方式。
n代表版本号，分为整型和浮点型
整型api接口管理规范： 大功能版本， 如v1、v2、v3 ...
浮点型： 补充功能版本， 如v1.1、v1.2、v2.1、v2.2 ...

客户端任何的修改都是需要发版的，发版需要审核流程。

客户端尽量只负责展示逻辑，不处理业务逻辑
客户端不处理金额的计算
客户端少处理请求参数的校验与约束提示

图片文案等，与校验规则类似，通过接口返回，并提供默认。

​ url连接一般采用https协议进行数据传输，可以提高数据交互过程中的安全性。

区分版本

合并接口

字段简写

无用字段清理

图片裁剪

局部刷新

预加载

其他

接口安全，防参数篡改

频率的控制

数据存储

是否需要依赖于第三方

服务降级，熔断和限流

拆分

扩展性

适配性

幂等

重复提交

部署

缓存穿透、缓存雪崩和缓存击穿

是否需要白名单

预加载

重试

异步

服务端推送或者客户端拉取数据

隔离（例如内网的中台服务，后端服务）

健康检查，后台大盘监控可视化，故障主动通知

API_接口测试规范

一、接口测试

接口测试主要用于检测外部系统与系统之间以及内部各个子系统之间的交互。测试的重点是要检查数据的交换api接口管理规范，传递和控制管理过程api接口管理规范，以及系统间的相互逻辑依赖关系等。

二、接口测试的意义

按照分层测试模型，处于中间层的接口测试，在稳定性，效率，成本，技术，实施难度上综合来讲，是收益最大的。相较于传统的UI层次的测试，接口测试把测试提前api接口管理规范了（时间上，架构上），并且能够覆盖到一些UI测试无法触及的功能点，提高api接口管理规范了测试的覆盖率，对质量控制提升了信心。接口测试也更容易实现自动化持续集成，支持后端快速发版需求，利于CT（持续测试）的开展。
三、认识URL

接口主要分为2大类api接口管理规范：

1.webservice接口

webService接口是走soap协议通过http传输，请求报文和返回报文都是xml格式的，我们在测试的时候都用通过工具（例如：soapUI）进行调用，测试。【暂时业务上用不到，不扩展】

2.http 接口

Http协议是建立在TCP协议基础之上的，当浏览器需要从服务器获取网页数据的时候，会发出一次Http请求。Http会通过TCP建立起一个到服务器的连接通道，当本次请求需要的数据完毕后，Http会立即将TCP连接断开，这个过程是很短的。所以Http连接是一种短连接，是一种无状态的连接。

3.URL解析

    在WWW上，每一信息资源都有统一的且在网上唯一的地址，该地址就叫URL（Uniform Resource Locator,统一资源定位符），它是WWW的统一资源定位标志，就是指网络地址。HTTP协议工作于客户端-服务端架构之上。浏览器作为HTTP客户端通过URL向HTTP服务端即WEB服务器发送所有请求。Web服务器根据接收到的请求后，向客户端发送响应信息。

 URL由三部分组成：资源类型、存放资源的主机域名、资源文件名。

也可认为由4部分组成：协议、主机、端口、路径

URL的一般语法格式为(带方括号[]的为可选项)：【参考 URL百度百科 】

protocol :// hostname[:port] / path / [;parameters][?query]#fragment

以下面的URL为例：

http://blog.xx.com.cn/s/blog_537ad6610102xtb1.html?tj=hist

1)、协议部分，代表页面使用的是http协议，在Internet中可以使用多种协议，如HTTP，FTP等等。在"HTTP"后面的“//”为分隔符；

2)、域名部分， blog.xx.com.cn ，也可以使用IP地址作为域名使用如：192.168.55.14:8080，其中8080为端口，域名和端口之间使用“:”作为分隔符。端口不是一个URL必须的部分，如果省略端口部分，将采用默认端口80/tcp；

3)、虚拟目录部分，从域名后的第一个“/”开始到最后一个“/”为止，是虚拟目录部分。虚拟目录也不是一个URL必须的部分。本例中的虚拟目录是“/s/”

4)、文件名部分：从域名后的最后一个“/”开始到“？”为止，是文件名部分，如果没有“?”,则是从域名后的最后一个“/”开始到“#”为止，是文件部分，如果没有“？”和“#”，那么从域名后的最后一个“/”开始到结束，都是文件名部分。本例中的文件名是“blog_537ad6610102xtb1.html”。文件名部分也不是一个URL必须的部分，如果省略该部分，则使用默认的文件名

5)、锚部分：从“#”开始到最后，都是锚部分。锚部分也不是一个URL必须的部分（可以理解为定位）

6)、参数部分：从“？”开始到“#”为止之间的部分为参数部分，又称搜索部分、查询部分。本例中的参数部分为“7.参数部分：从“？”开始到“#”为止之间的部分为参数部分，又称搜索部分、查询部分。本例中的参数部分为“boardID=5ID=24618page=1”。参数可以允许有多个参数，参数与参数之间用“”作为分隔符。”。参数可以允许有多个参数，参数与参数之间用“”作为分隔符。

四、测试范围及用例设计思路

接口测试范围分为以下5个方向：
五、测试流程

分析接口文档和需求文档（接口说明、请求方式、请求URL、请求参数、返回数据、返回实例）

接口用例设计   

编写接口测试用例

接口测试执行

输出接口测试报告。

六、如何快速评估自己的测试用例覆盖率：

1）参数验证是否完整（包括各种边界和业务规则）

2）业务需求点覆盖是否完整（单接口业务功，依赖接口业务功能）

3）接口异常场景覆盖是否完整（数据的异常）

八、接口测试用途

回归测试

非功能性测试

增量开发，持续集成的项目。

api接口程序的管理方式

API管理最重要的方面包括检测，分析和报告。传统的管理格言是，“无法管理没有指标的东西。”如果企业不仅仅满足于暴露API和服务，而是要管理他们，必须要度量关键指标，并将其应用到决策制定流程里。
度量不仅仅是设置一些阀值，并且在红色警报出现时做出反应。如果没有定期收集数据、分析并且用于决策制度，企业可能能做的更多只是做出反应，而不是真正的管理。要管理API，管理工具要能够完全提供健壮的能够驱动管理决策的数据集。网关管理工具收集使用信息，验证使用在合约限制之内，如果不是，就相应拒绝或者节流该请求。要达到这个目标，指标必须完全基于流量检测。这需要涉及到比如请求数量，相应事件和消息大小。

vue入门：对vue项目中api接口的封装管理

在以前的文档中，我们构建了vue项目的整体架构，详见 vue入门：vue项目架构设计起步 ，现在我们主要对其中的api接口封装进行完善，并将过程做个记录，与之分享。

很多朋友在开发过程中，习惯性直接将api的调用写在单个组件之中，就直接调用请求。例如：
在前端项目开发中，从整体架构出发，我们可以将项目中所有api进行封装，从而便于我们进行统一管理。

在src目录下，新建api文件夹，在api文件夹下创建index.js和api.js。

1、api.js。主要用来统一管理项目所有api请求。 如下：

import axios from 'axios'

let host = window.g.ApiUrl

// 获取主页信息

export const getindex = params = { return axios.get(`${host}/api/index/`, { params: params }) }

// 获取城市信息

export const getcity = params = { return axios.get(`${host}/api/city/`) }

// 获取详细信息

export const getdetail = params = { return axios.get(`${host}/api/detail/`, { params: params }) }

// 注册

export const postRegister = params = { return axios.post(`${host}/api/register/`, { params: params }) }
2、index.js。主要用来输出api，供外部引入。 如下：

import * as api from './api'

export default api
3、在组件中调用api接口 。例如：
这样，我们就可以在api.js中查阅到项目中所有api接口的调用，便于接口的管理。 关于api接口管理规范和软件接口规范文档的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 api接口管理规范的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于软件接口规范文档、api接口管理规范的信息别忘了在本站进行查找喔。

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