Apifox软件使⽤技巧
  软件开发过程中，接⼝管理、调试、⾃动化测试是必不可少的，我们经常使⽤ Postman 等⼯具来进⾏接⼝调试，在接⼝调试⽅⾯ Postman 做的⾮常出⾊。但是在整个软件开发过程中，接⼝调试只是其中的⼀部分，还有很多事情 Postman ⽆法完成，或者⽆法⾼效完成，⽐如：接⼝⽂档定义、Mock 数据、接⼝⾃动化测试等等。⽽ Apifox 就是为此⽽⽣的。那我们今天就来说说Apifox接⼝设计 (接⼝⽂档)。
接⼝设计 (接⼝⽂档)
接⼝设计即定义接⼝⽂档规范（如接⼝路径、参数、返回值、数据结构等，和 Postman 不⼀样，Apifox 是区分接⼝设计和接⼝运⾏两个概念的）
接⼝设计
新建接⼝界⾯或接⼝详情⾥的编辑界⾯，⽤途是定义接⼝⽂档规范，⽽不是运⾏接⼝，所以该界⾯是只能定义接⼝基本信息、参数名及参数说明等，⽽不能设置参数值。
参数值、预执⾏脚本/后执⾏脚本等信息请在接⼝运⾏界⾯或接⼝⽤例界⾯填写。
在打开的窗⼝中，直接定义接⼝相关信息
接⼝路径
不可包含Query 参数（即 URL 中 ?后的参数），Query 参数在下⽅请求参数部分填写。
注意
接⼝路径建议不要包含 HTTP 协议及域名，这部分建议在环境管理的前置URL⾥设置，接⼝调试时的 URL 会⾃动加上当前环境的前置URL。
特殊情况需在接⼝路径要带上HTTP 协议及域名的，系统也能⽀持，但不建议这么做。接⼝调试时，系统如检测到接⼝路径是以或起始的，会⾃动忽略⾥当前环境⾥前置 URL。
Apifox 中的 Path 参数是以⼤括号包裹起来表⽰，⽽⾮冒号起始表⽰。正确⽰例：/pets/{id}，错误⽰例/pets/:id。
基础信息
这部分⽐较简单，⼀看就懂，不再赘述。
请求参数
Params 参数
  包含 Query 参数和 Path 参数两部分。
    Query 参数：即 URL 中 ?后的参数。
    Path 参数：⾃动提取接⼝路径中⼤括号包裹起来的参数，如/pets/{id}中的的{id}即表⽰名为id的 Path 参数。
Body 参数
none：⽆ body 参数。
form-data：即 Content-Type 为multipart/form-data。
x-www-form-urlencoded：即 Content-Type 为application/x-www-form-urlencoded。
json：即 Content-Type 为 application/json。
xml：即 Content-Type 为 application/xml。
binary：发送⽂件类数据时使⽤。
raw：发送其他⽂本类数据时使⽤。
注意
GET⽅式的接⼝，body 参数只能设置为none。
Body 参数类型为json或xml时，需要设置数据结构，并且数据结构可以引⽤数据模型，
接⼝发送请求的时候会根据Body 参数类型⾃动在请求Header加上对应的Content-Type，⽆需⼿动设置。
若需要⼿动设置Header中的Content-Type，则其值必须和Body 参数类型相匹配，否则系统会⾃动忽略掉⼿动设置的Content-Type。
参数中使⽤环境变量（或全局变量/本地变量）
接口文档怎么看  所有参数都可以使⽤变量，使⽤⽅式为双⼤括号包裹变量名，如{{my_variable}}，表⽰引⽤名为my_variable的变量。
  参数值使⽤变量时可以包含变量以外的字符串，如：参数值设置为prefix-{{my_variable}}-surfix，假设运⾏时变量my_variable的值为123，则实际请求时参数的值为prefix-123-surfix。
返回 Response
返回 Response 定义主要包含以下⼏部分
  接⼝返回的 HTTP 状态码
  返回内容的数据格式：JSON、XML、HTML、Raw、Binary
  数据结构：仅JSON、XML可配置数据结构，关于数据结构详细说明，请查看⽂档：数据结构/数据模型
注意
当⼀个接⼝在不同情况下会返回不同数据结构时，可设置多个返回 Response。点击返回 Response模块右上⽅的+ 新建即可添加。
定义好数据结构后，接⼝调试时，系统会⾃动校验返回的数据是否符合定义的数据结构，⾮常⽅便，更多说明请查看⽂档：接⼝调试/接⼝⽤例。
定义好数据结构后，使⽤ mock 功能时，系统会⾃动根据定义的数据结构 mock 出⾮常⼈性化的数据，⾮常⽅便，更多说明请查看⽂档：Mock 数据
公共 Response
公共 Response主要⽤来实现 Response 的复⽤。通常不同接⼝在某些情况下会返回相同的数据结构，如资源不存在(404)、没有访问权限(401)等，这些建议设置为公共Response，避免重复编写，放⽅便统⼀管理。
设置⽅法：打开项⽬设置->公共 Response，在这⾥管理公共 Response
接⼝运⾏
接⼝详情⾥的运⾏界⾯，⽤途是临时调试接⼝，运⾏完后，需要点击保存为⽤例，才能将填写的参数值、预执⾏脚本/后执⾏脚本等信息保存下来；否则关闭 tab 后，这些信息将会丢失。
更详细说明前往

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。