ApiPost和PostMan，可以选择合适的接口管理工具（API接口管理系统php版）

总结：还有对应返回值字段的说明。 这个方法可以让你随时随地测试和更新你的文档，这对于我们后端的朋友来说是个好消息。 不过不知道朋友有没有发现这个问题。 这意味着您在生成接口文档时必须自己输入参数描述。 这对于学生来说是一个非常好的功能。

我们都知道一个团队由业务、产品、设计、前端、后端、测试等多种角色组成。 每个角色各司其职，共同完成项目实施。

前端和后端之间的通信必须通过统一的文件进行通信。 这意味着后端接口返回的内容是通过接口文档提前约定好的，然后大家都同意的。 根据本文档完成您的前后端开发。 另外，接口文档通常由后端人员创建，维护过程相对繁琐。

最近，群里的一个朋友得到了一个界面管理工具，叫ApiPost。 Moxi尝试了一下，感觉很棒，所以我想在这里分享一下。

ApiPost包含接口调试、接口文档、mock工具、接口流程测试四大功能。

ApiPost = API接口调试工具+快速接口文档生成+mock工具+接口流程测试

API接口调试工具：常见的有Postman、Post Woman等。

快速生成接口文档：常见的接口文档工具有Swagger和Smart-doc，但它们对你的代码侵入性比较大。

Mock工具：主要用于前端根据RAP等工具的接口生成相应的数据。

接口测试：常见的接口测试工具有JMeter。

同时，ApiPost也是国人开发的界面管理工具，致力于打造更加人性化的中文界面。 调试和文档管理工具（幸亏我英语不好~）

ApiPost主页

格式化API接口调试代码

接口调试是使用经典ApiPost Perform的开发阶段。最常用的功能。 接口调试功能

ApiPost执行传统的接口调试功能

这个我觉得最好的部分是返回的参数可以是Json格式。 Postman 附带的漂亮功能包括：

Postman自带的Pretty函数

下面是ApiPost的Json Pretty函数。 传递的右侧的三角形可以展开或折叠数组元素。 当返回的结果是一个数组并且每个对象有多个字段时，此函数效果最佳。

ApiPost的Json格式化功能

即使不比较也没有问题。 让我们看一下 Postman 的输出。 对于输出，每次只能复制结果，在线打开并格式化Json，然后再检查返回的结果，但这只会增加额外的负担。

Json格式：https://www.sojson.com/

在线Json格式

全局参数

同时，还有一件我非常喜欢的事情。 这是一个全局参数。

上例中，在向后台请求数据检索之前，必须在接口中输入相应的认证请求头。

全局参数

但是在实际项目中在本项目中，当我们需要批量测试接口时，往往需要为每个接口输入相同的认证请求头，这样流程就非常繁琐。 使用 ApiPost 时，您可以使用全局或目录参数来实现此目的。

全局参数

配置后，以后的接口在再次请求时将使用后台。 传递全局定义的请求标头。 它还支持全局查询和主体。 一些不变的请求参数可以配置为全局参数。 这样在创建接口请求的时候会节省你很多时间~

目录参数

同时你也可以创建不同的目录来区分项目接口所在的不同模块。 示例：以蘑菇街博客为例，可以创建两个目录：mogu-admin 和 mogu-web。 它们分别代表蘑菇博客的后端管理项目和门户项目。

蘑菇博客地址：https://gitee.com/moxi159753/mogu_blog_v2

后台管理和门户有两个认证逻辑，也就是说整体情况如上。 上述两种场景下，token配置不会生效。

如果我还想同时测试portal类相关的接口或者后台管理相关的接口怎么办？

此时应该使用目录参数。 功能与全局参数相同，但范围不同。 mogu-admin目录下的接口不使用同级别的mogu-。 Web 目录的目录参数用作提交参数。

目录参数

为每个目录设置不同的全局参数即可解决问题。 刚才的场景。

如果全局参数、目录参数、接口同时使用同一个参数，则最终按照以下优先级读取参数值：

单一界面>目录参数>全局参数

同上例，如果全局参数、目录参数、接口中都定义了头参数token：

全局参数： Token value: 698d51a19d8a121ce581499d7b701668 // 最低优先级目录参数： Token value: b50e345cc9febd86dedecc551ebcc505 // 第二优先级 单个接口参数： token值为：a1a9db893bb8a28ccb665d2af54d9417 //最高优先级

最终发送的token值为：a1a9db893bb8a28ccb665d2af54d9417

快速生成接口文档

点击分享文档，获取对应文档链接

p>

复制文档地址即可查看完整的接口文档。

细心的朋友可能会注意到，这个请求参数缺少任何相关字段的介绍。 返回上一级ApiPost页面，点击Extract Fields and Descriptions，输入对应的字段名称。

然后您可以重新发布并查看每个字段的含义。

一些细心的朋友可能会发现这里缺少返回值的原因。 这是因为 APIPOST 不使用发送后的实时响应数据作为响应示例。 此时，您必须手动将实时响应结果导入或复制到相应的成功和错误响应示例中。

接下来，重新生成文档。 这次，我们想介绍一下我们的成功故事。

还有对应返回值字段的说明。

这个方法可以让你随时随地测试和更新文档，这对后端伙伴来说是个好消息~

但是，如果你的朋友在生成接口文档时发现了任何问题，。

输入参数描述是最繁琐的，尤其是对于很多有很多同名参数的界面来说，每次都手动输入是非常繁琐的。耗时且效率低下。目前可以通过定制ApiPost参数描述库来解决这个问题，通过参数描述库，很多参数都是预先标注的。

参数描述库一旦出现就会自动同步。如果输入相同的名称，则会自动生成相应的描述。

Mock Tools

如果没有开发后端接口，则不会完全开发该接口。都知道数据是无法取回的，所以前端小伙伴要提前通过Mock编写API的数据生成规则，工具通过访问Mock来动态处理API的返回数据，并取回所需的数据。页面中，前端和后端人员只需定义接口文档就可以开始并行工作，而不会产生任何影响；只有在协同调试的最后阶段才能密切接触。

有了ApiPost。 ，你可以在没有后端程序的情况下工作，要真正返回接口数据，你可以在项目早期使用ApiPost来演示纯前端效果，或者在开发过程中使用ApiPost来实现数据模拟，以实现与前端的集成。隔离。

同时ApiPost支持参数​​直接引用mock。 .js 变量。 单击下面查看内置模拟字段变量。

以下是当今常用的内置变量。

@guid()：随机生成GUID。 示例：DEfbBBBf -7A23-a4DB-9BB1-57BCFf5FB5fc

@integer(1,100)：生成 1 到 100 之间的随机整数

@datetime( "yyyy[ k4]MM-dd HH:mm:ss")：返回随机日期和时间字符串。 示例：1977-11-17 03:50:15

@url("http")：生成随机 http URL。

@email()：随机电子邮件地址

@province()：随机生成中国的一个省（或市、自治区、特别行政区）。

@city()：随机生成一个中国城市。 p>

@title()：随机生成标题

@cname()：随机生成中文名

@cparagraph()：生成随机中文文本

> p>

让我们使用这些常见的模拟变量来生成模拟服务。

首先点击模拟服务，然后编辑模拟模板。 右侧显示实时生成的模拟数据。

点击上面的复制链接，可以向您的前端合作伙伴模拟请求此接口，并将其用于我们将携带的各种内容共同发展。

测试流程

流程测试是对接口集合的测试。 选择相应的环境并将它们作为一系列请求一起执行。 流程测试对于自动化 API 测试很有用。 当您单击“开始”时，接口集合同时向服务器发送请求，并根据上次定义的条件进行测试。测试验证模块提供测试结果。 这对于学生来说是一个非常好的功能。

使用 ApiPost 创建流程测试需要以下步骤：

创建一个新接口并添加断言。

打开流程测试并创建新流程

为流程添加测试接口

选择环境，点击开始测试]

查看返回的测试接口

处理测试接口

点击接口名称即可查看请求的请求和响应参数信息。

同时，ApiPost还提供了很多内置的函数。 例如，变量可以轻松解密。

ApiPost的更多功能等待您的朋友发现。 好了，这个问题就到此为止了。