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

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

全局参数和目录参数

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

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

全局参数

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

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

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

目录参数

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

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

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

参数的优先级

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

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

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

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

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

相关文章
|
XML JSON 数据可视化
后端适用,Apifox接口文档设计和调试教程【工具篇】
对后端研发人员来说,Swagger+Postman 是接口设计和调试的必备工具,这两个工具都非常出色, 但不同系统间项目数据不互通,在变更、维护和协同上比较低效,另外是封装程度较低,使用上流程较为繁琐。
后端适用,Apifox接口文档设计和调试教程【工具篇】
|
前端开发 JavaScript 测试技术
前端、后端、测试、研发经理必备技能-ApiPost接口管理工具
前端、后端、测试、研发经理必备技能-ApiPost接口管理工具
前端、后端、测试、研发经理必备技能-ApiPost接口管理工具
|
10天前
|
缓存 Java 数据库
后端技术探索:从基础架构到高效开发的实践之路
【10月更文挑战第7天】 在现代软件开发中,后端技术是支撑应用运行的核心。本文将探讨如何从后端的基础架构出发,通过一系列高效的开发实践,提升系统的性能与可靠性。我们将深入分析后端框架的选择、数据库设计、接口开发等关键领域,并提供实用的代码示例和优化策略,帮助开发者构建更稳定、高效的后端系统。通过这篇文章,读者将获得关于后端开发的全面理解和实践指导,从而更好地应对复杂项目需求。
36 0
|
11天前
|
设计模式 API 开发者
探索现代后端开发:微服务架构与API设计
【10月更文挑战第6天】探索现代后端开发:微服务架构与API设计
|
11天前
|
JavaScript API 微服务
探索现代后端开发:关键技术和最佳实践
【10月更文挑战第6天】探索现代后端开发:关键技术和最佳实践
|
5天前
|
JavaScript Java Go
后端开发中常用的编程语言
【10月更文挑战第12天】后端开发中常用的编程语言
15 8
|
1天前
|
缓存 Java 数据库
后端开发的艺术与科学
在这篇文章中,我们将深入探讨后端开发的核心理念和技术。从基础的编程语言和框架到复杂的系统架构和性能优化,我们将一探究竟。无论你是初学者还是有经验的开发者,这篇文章都将为你提供有价值的见解和实用的技巧。让我们一起走进后端开发的世界,探索它的艺术与科学。
|
1天前
|
Java 持续交付 微服务
后端开发中的微服务架构实践与挑战####
本文深入探讨了微服务架构在现代后端开发中的应用,通过具体案例分析,揭示了其如何助力企业应对业务复杂性、提升系统可维护性和可扩展性。文章首先概述了微服务的核心概念及其优势,随后详细阐述了实施微服务过程中的关键技术选型、服务拆分策略、容错机制以及持续集成/持续部署(CI/CD)的最佳实践。最后,通过一个真实世界的应用实例,展示了微服务架构在实际项目中的成功应用及其带来的显著成效。 ####
|
2天前
|
负载均衡 监控 API
后端开发中的微服务架构实践
【10月更文挑战第15天】 在当今的软件开发领域,微服务架构已成为一种流行的技术趋势。本文将探讨微服务架构的基本概念、优势以及在实际后端开发中的应用。我们将通过具体案例分析,了解如何设计和实现一个高效的微服务系统,以及如何应对在实施过程中可能遇到的挑战。
13 1

热门文章

最新文章