ApiFox的使用

清疚 2023-10-15 04:59 34阅读 0赞

官网：https://www.apifox.cn/

##### **项目的创建** #####

点击主页的新建项目，填写项目信息

![cd188d41a6db44e1929e81d6dad0932c.png][]

##### **接口设计** #####

可以先创建目录 注意对接口进行分类

在对应的目录下新建接口：

![4e397461eefe4e5fa6a9761afb63b2ff.png][]

在一个接口中，ApiFox 允许你添加以下部分：

接口名称、分组、状态、责任人、服务、标签、说明

请求方法（GET、POST、PATCH、PUT、DELETE、HEAD 等）

请求路径（比如 /hello/world/\{world\_id\}?offset=0&limit=25）

请求参数（Query 与 Path）

请求体

请求头

Auth

SSL 设置、自动重定向

响应结果（返回结果）

###### **请求方法** ######

ApiFox 支持定义 GET、POST、PUT、DELETE、OPTIONS、HEAD、PATCH、TRACE、CONNECT、COPY、LINK、UNLINK、PURGE、LOCK、UNLOCK、MKCOL、MOVE、PROPFIND、REPORT、VIEW 方法。

###### **请求路径 & 请求参数** ######

请求路径中填写 ip:port 或 ip:port/project\_name 之后的路径

在请求路径中，可以添加请求参数（Query Parameters）和路径参数（Path Parameters），例如 /hello/world/\{world\_id\}?offset=0&limit=25，其中的请求参数 offset、limit 与路径参数 world\_id 都会在请求参数部分自动出现

进行一些环境的配置，比如在本地调试环境配置前置URL，编写接口，调试接口都可以省去前置的URL：[http://localhost:8080][http_localhost_8080] ,攥写时只需要编辑业务部分，适应在不同环境的接口运行调试

###### **请求参数** ######

![3b3b784a72e14b9eb04cf319060f087d.png][]

###### **请求体** ######

选择数据传输的类型，填写发送请求的具体字段和类型，填写说明

对于每个请求体中的字段，可以设置其数据类型、Mock 正则式、高级设置（如下图，可以设置默认值、枚举、数值范围等，可以通过编辑源码直接进行规则设置）：

###### **请求头** ######

请求头（Request Headers）是 HTTP 请求（HTTP Request）中包含的元数据。它包含了一些键值对（key-value pairs），用于描述客户端和服务器之间的通信细节，包含以下：

![11e4e4c4cada419dbcc0fbb295309f1c.png][]

###### **响应体** ######

响应体的字段设置类似于请求体

**创建数据模型**

支持多种方式导入，也可以手动填写

###### **测试** ######

对后端来说类似接口测试工具postman

自动生成合适的测试数据

我们可以像使用 Postman 一样在接口测试中添加 Params、Body、Headers 等测试数据，

但是其强大在于我们可以根据在前文的「请求体」中设置的 Mock 正则、默认值、枚举等信息自动生成接口测试数据

保存测试用例

不同于 Postman 以组为粒度，ApiFox 以每个具体的接口为粒度保存测试用例：

###### **Idea的apifox插件** ######

apifoxHelper

![ad8dd759a6c9412ab9d04917ba4d71bf.png][]

###### **Mock** ######

在后端还没写好接口时，前端需要使用一个假数据接口来进行前端页面的数据渲染测试工作，ApiFox 提供了这个 Mock 功能，并可以根据以上设置的规则自动生成合适 Mock 数据：

![d3dde19d8fbc489ca96063f5204b910e.png][]

###### **接口文档共享** ######

###### **团队管理：** ######

![e10e7cbb4c6e4bfc93a9dbd7075e228a.png][]

[cd188d41a6db44e1929e81d6dad0932c.png]: https://img-blog.csdnimg.cn/cd188d41a6db44e1929e81d6dad0932c.png
[4e397461eefe4e5fa6a9761afb63b2ff.png]: https://img-blog.csdnimg.cn/4e397461eefe4e5fa6a9761afb63b2ff.png
[http_localhost_8080]: http://localhost:8080
[3b3b784a72e14b9eb04cf319060f087d.png]: https://img-blog.csdnimg.cn/3b3b784a72e14b9eb04cf319060f087d.png
[11e4e4c4cada419dbcc0fbb295309f1c.png]: https://img-blog.csdnimg.cn/11e4e4c4cada419dbcc0fbb295309f1c.png
[ad8dd759a6c9412ab9d04917ba4d71bf.png]: https://img-blog.csdnimg.cn/ad8dd759a6c9412ab9d04917ba4d71bf.png
[d3dde19d8fbc489ca96063f5204b910e.png]: https://img-blog.csdnimg.cn/d3dde19d8fbc489ca96063f5204b910e.png
[e10e7cbb4c6e4bfc93a9dbd7075e228a.png]: https://img-blog.csdnimg.cn/e10e7cbb4c6e4bfc93a9dbd7075e228a.png