后端人员使用apipost快速生成接口文档

全局参数和目录参数

                    <div class="markdown-section">前面的示例中,我们都是在单一接口中填入不同的请求header、query、body参数。但在实际项目中,对于一批接口,往往具有相同的请求参数。此时,我们可以利用全局参数或者目录参数实现。

例如:常见的token令牌参数,假使我们请求项目下的任何接口都需要在header带上token参数,那么我们当然可以每个接口的header参数都写一个token,但是这样的话十分不利于后期维护、修改。

全局参数

后端人员使用apipost快速生成接口文档

我们打开全局参数管理器,在全局header除填上token参数:

后端人员使用apipost快速生成接口文档

那么我们每次发送接口,都会在请求header中自动带上该参数:

后端人员使用apipost快速生成接口文档

全局query和全局body的使用方法跟全局header类似,不再赘述。

目录参数

目录参数的作用和全局参数雷同,只是作用域不一样,B目录下的接口不会使用同级的A目录的目录参数作为发送参数。

我们可以通过编辑目录进行目录参数的填写:

后端人员使用apipost快速生成接口文档

那么我们每次发送该目录下的接口,都会在请求header中自动带上该参数:

后端人员使用apipost快速生成接口文档

参数的优先级

当全局参数、目录参数、接口中都使用了同一个参数时,最终会按照以下优先级读取参数值:

单个接口 > 目录参数 > 全局参数

如上面的示例,如果全局参数、目录参数、接口中都定义了header参数token:

全局参数:token值为:698d51a19d8a121ce581499d7b701668 // 最低优先级
目录参数:token值为:b50e345cc9febd86dedecc551ebcc505 // 其次优先级
单接口参数:token值为:a1a9db893bb8a28ccb665d2af54d9417 // 最高优先级

那么最终发送的token值为:a1a9db893bb8a28ccb665d2af54d9417

上一篇:干货连载 | 这才是下一代企业级数据库系统该有的样子!


下一篇:centos升级gcc版本