- 博客(172)
- 收藏
- 关注
RSS订阅原创 如何让 Apifox 发布的在线文档具备更好的调试体验？
这篇文章介绍了如何优化Apifox在线API文档的调试体验，主要从URL配置、鉴权设置、参数设计和示例数据四个方面给出建议：1）URL配置推荐使用环境变量管理前置URL，支持多环境切换；2）合理配置鉴权信息，支持多种鉴权方式并自动处理凭证；3）设计清晰的参数结构，提供参数示例避免冗余；4）准备丰富的请求/响应示例和代码片段。正确的配置能显著提升API文档的可用性，让开发者更高效地调试接口。
2025-09-11 10:24:08
952
原创 理解和掌握 Apifox 中的变量（临时、环境、模块、全局变量等）
Apifox变量使用指南：Apifox提供多种变量类型（团队/项目全局变量、模块变量、环境变量等）用于管理API测试数据。变量优先级从高到低为：临时变量＞测试数据变量＞环境变量＞模块变量＞项目全局变量＞团队全局变量。变量支持远程值（团队共享）和本地值（个人使用），可通过环境管理、提取响应数据或脚本设置。使用{{变量名}}语法引用变量，支持读取JSON子元素。测试数据变量可实现数据驱动测试，动态值表达式可生成随机测试数据。合理使用变量能提升API测试效率。
2025-09-04 12:04:52
659
原创 Apifox 8 月更新｜新增测试用例、支持自定义请求示例代码、提升导入/导出 OpenAPI/Swagger 数据的兼容性
Apifox新版发布，带来多项功能升级与优化。重点更新包括：支持创建接口测试用例和多场景验证；文档功能增强，新增自定义首页和请求示例代码配置；提升数据兼容性，优化OpenAPI/Swagger导入导出；支持批量导入Postman Collection和自动备份到GitLab仓库。同时修复了数据库连接、SSH隧道、文件下载等多项问题，优化了用户体验。新版本在接口测试、文档管理、数据迁移等方面均有显著提升，为团队协作提供更高效的工具支持。
2025-08-27 12:14:52
825
原创 API 文档中有多种参数结构怎么办？Apifox 里用 oneOf/anyOf/allOf 这样写
摘要：Apifox支持JSON Schema的oneOf、anyOf、allOf特性，能精确描述复杂的API参数结构。allOf用于合并多个结构（逻辑与），anyOf表示"满足其一即可"，oneOf要求"必须且只能匹配一个"。通过可视化编辑或JSON Schema代码模式，开发者可以定义这些组合模式，并将其应用到接口请求参数和响应数据中。allOf适合拆分复杂对象，anyOf适合多选一场景，oneOf则适用于互斥选择。这些功能使API文档能更准确地描述多变的业务需求，
2025-08-13 09:00:00
989
原创 如何在 Apifox 中给字段设置枚举（比如字符串、数组等）？
【摘要】枚举是接口设计中限定字段取值范围的常用方法，如用户状态只能选"active"、"frozen"等固定值。Apifox支持字符串、数组等多种数据类型的枚举设置，可细化到数组元素或整体组合值。通过可视化界面或JSON Schema均可配置，还支持AI智能生成枚举规则。公共枚举可定义为数据模型供多接口复用。合理使用枚举能提升接口规范性，配合Mock数据生成和唯一性校验，确保开发测试数据始终合规，有效提升团队协作效率。
2025-08-06 12:19:43
1015
原创 Apifox 7 月更新｜通过 AI 命名参数及检测接口规范、在线文档支持自定义 CSS 和 JavaScript、鉴权能力升级
Apifox最新版本带来多项重磅升级：AI助力接口设计，支持智能命名和规范性检测；在线文档增强，新增自定义CSS/JS、Webhook/Callback接口支持；鉴权能力全面优化，包括OAuth 2.0交互改进和离线空间功能；数据库连接支持SSL加密和更多MongoDB数据类型；同时修复了Socket.IO调试等多项问题。此外还包含OpenAPI生成器升级、SQL建表优化等20+功能改进，全面提升API开发效率和体验。
2025-07-31 09:00:00
694
原创 如何在 Apifox 中正确使用前置 URL？
Apifox中前置URL的使用方法：将API地址中重复部分（如https://api.example.com/v1）提取为前置URL，接口只需填写相对路径（如/users）。通过环境管理可为不同环境设置不同前置URL，实现多环境切换。针对微服务架构，推荐将各服务拆分为独立模块，为每个模块配置专属前置URL。前置URL支持版本号管理，也允许在特定接口中覆盖使用完整URL。这种管理方式能有效提升API维护效率，确保请求地址的准确性。
2025-07-23 10:46:13
1056
原创 提交代码后如何自动触发 Apifox 的自动化测试？
团队协作开发中常面临手动执行接口测试的痛点。本文介绍如何利用CI/CD平台实现代码提交后自动执行测试的方案。核心原理是通过Git事件监听触发Apifox CLI命令执行，主要包含两种实现方式：1)直接使用GitHub Actions等平台内置事件机制；2)通过Webhook实现跨平台联动（如GitHub+Jenkins）。文章详细说明了Jenkins的Webhook配置步骤，包括插件安装、URL获取和GitHub设置，并验证了整体流程可行性。该方案可显著提升测试
2025-07-09 10:50:59
856
原创 Apifox 发布 API 文档后，如何控制访问权限？5 种方法轻松搞定
如果前面这些都满足不了需求，还有个高级选项——自定义登录页。这个功能让你可以用自己的用户系统来控制文档访问权限。工作流程是这样的：用户访问文档站时，先跳转到你自己的登录页面。用户完成身份验证后，你的服务器生成一个 JWT Token，然后把用户重定向回文档站，同时把 Token 作为参数传过去。Apifox 验证这个 Token，通过了就允许访问。这种方式的好处是完全按照你的业务逻辑来控制权限。虽然需要一些开发工作，但对于有复杂权限需求的企业来说很有价值。
2025-07-02 09:45:00
863
原创 Apifox 6 月产品更新｜支持 AI 能力、交互优化、在线文档新增 SEO 设置、gRPC 项目支持前/后置操作
Apifox最新版本带来多项重要更新：引入AI能力支持数据模型智能修改与补全，新增一键对接AI编程工具Cursor的功能；gRPC项目支持调试时的前后置操作；优化了数据导入、URL显示等交互体验；在线文档新增SEO设置；强化项目组织能力，支持模块化管理并自动备份至Github；IDEA插件支持精准数据导入。此外还修复了二进制响应查看等用户反馈问题，持续优化产品细节和使用体验，为用户提供更高效专业的API开发工具。
2025-06-25 09:00:00
833
1
原创 Apifox SEO 设置全解析：让你的 API 文档更容易被搜到
Apifox文档站提供全面的SEO优化功能，包含页面级和站点级设置。页面级优化支持自定义URL、MetaTitle/MetaDescription/keywords设置，以及自定义Metadata标签。站点级管理包括全局Metadata配置、robots.txt管理、sitemap.xml自动生成和文档重定向规则。URL支持两种自动生成策略：包含标题+ID或纯ID形式。建议从全局配置开始，重点优化核心页面，并持续跟踪SEO效果。这些功能帮助API文档在搜索引擎中获得更好排名，但需配合优质内容和长期优化才能见
2025-06-18 10:46:36
388
原创 Apifox 测试步骤之间怎么传递数据？搞懂上下游参数传递这一篇就够了！
Apifox自动化测试数据传递指南：本文详细解析了Apifox测试流程中不同类型步骤间的数据传递机制，包括接口响应、数据库查询、循环和脚本四种场景。核心介绍了两种数据传递方式：动态值即时引用和变量中转存储，并具体说明了每种测试步骤的数据提取方法及下游使用场景。通过合理组合这两种机制，用户可以构建灵活的数据驱动测试流程，实现跨步骤的数据联动。文章建议根据数据使用频率选择传递方式，简单数据用动态值，复杂数据提取为变量。
2025-06-05 14:03:23
851
原创 Apifox 5 月产品更新｜数据模型支持查看「引用资源」、调试 AI 接口可实时预览 Markdown、性能优化
Apifox最新版本带来多项功能优化：支持自动解析JSON参数名和值、AI接口调试新增Markdown预览、独立进程执行请求以提升性能、数据模型可查看引用资源、gRPC支持服务器反射导入接口。同时优化了Redis连接配置、批量测试通知机制，并修复了SSE接口特殊字符处理等多项问题。新版本还增强了多版本管理、组合鉴权等功能，全面提升接口调试和管理效率。
2025-05-28 11:44:04
1139
原创 用 Apifox Markdown 打造高颜值产品文档的 10 个技巧
Apifox 能通过灵活的 Markdown 语法，帮助团队打造专业级产品文档。今天就为大家介绍 10 个在 Apifox 中使用 Markdown 撰写产品文档的实用技巧，一起来看看吧！
2025-05-13 12:06:32
1133
原创 Apifox 4月更新｜Apifox在线文档支持LLMs.txt、评论支持使用@提及成员、支持为团队配置「IP 允许访问名单」
我们优化了 OpenAPI 文件的导入逻辑。当导入的接口 body 中定义了多种 media type 时， Apifox 会按照序列导入顺位第 1 个。对于包含多种内容类型定义的 API 文档提供了更清晰的导入行为。我们修复了当接口响应被定义为 No-Content 时，Mock 服务的响应时间异常的情况，确保了更快速和高效的响应，为开发和测试流程提供更好的支持。
2025-04-24 11:29:51
1003
转载 Apifox 全面支持 LLMs.txt：让 AI 更好地理解你的 API 文档
通过 LLMs.txt 功能，你的 API 文档将成为 AI 理解你项目的理想载体，为开发效率带来质的飞跃，快去试试吧！
2025-04-17 14:54:54
1256
原创 如何在 Apifox 中通过 Runner 运行包含云端数据库连接配置的测试场景
如果你需要运行的测试场景中，所有数据库连接使用的配置全部都是保存在云端的配置，则 Runner 运行时可以直接从云端拿到数据库连接配置中所需要的变量，并根据变量替换规则去找到实际变量值，来发起连接。7. 如果你是使用定时任务来让 Runner 运行此测试场景，则需要在此测试场景的详情设置中，设置环境/全局变量值使用保存在 Runner 中的本地值，并选择一个合适的变量范围。每个需要使用的环境都设置好。3. 确保你要使用 Runner 运行的测试场景中，都使用的“云端数据库连接配置”，即使用变量保存的配置。
2025-04-03 16:39:41
834
原创 如何在 Apifox 中通过 CLI 运行包含云端数据库连接配置的测试场景
如果使用了云端数据库连接配置，则可以完全省去导出配置文件、放入 CLI 执行机器中、命令行填写选项具体值这些工作，只需要给云端数据库连接配置中的变量设置好实际的值即可成功运行，让体验得以提升。如果你需要运行的测试场景中，所有数据库连接使用的配置全部都是保存在云端的配置，则导出数据库连接配置的入口便不会出现（因为不需要了），CLI 运行时可以直接从云端拿到数据库连接配置中所需要的变量并根据变量替换规则去找到实际变量值，来发起连接。1. 在环境管理中，将数据库连接的实际值设置在了对应变量的本地值中。
2025-04-03 15:30:16
1101
原创 Apifox 3月更新｜发布/分享的API文档全面升级、支持MCP、支持调试Ollama本地部署AI大模型接口、新增「鉴权组件」
Apifox 在 3 月为大家带来了一大波新功能，赶快更新到最新版本一起体验吧！
2025-04-01 12:02:28
1320
原创 如何在 Apifox 中调试 Socket.IO 接口？
握手路径若服务端使用了非默认握手路径，可以在「设置」面板同步修改配置。确保此配置与服务端完全一致，否则将无法建立连接。Apifox 为 Socket.IO 开发者提供了一站式的调试解决方案，从建立连接到事件监听、消息收发的全流程都有直观的可视化支持。无论你是前端工程师验证与后端的通信逻辑，还是后端开发者测试服务实现，Apifox 都能显著提升你的 Socket.IO 开发体验，让实时应用开发更加高效可靠。
2025-03-20 14:15:36
1307
原创 一文讲透 MCP，开启 Apifox MCP Server 内测之旅
带大家快速读懂 MCP ，同时邀请大家使用 Apifox MCP Server,将 Apifox 项目内的接口文档作为数据源提供给 AI 工具，一起探索 AI 和 API 协作的未来。
2025-03-20 11:10:30
740
原创 无需技术能力！通过 Apifox 与你的产品/运营同事一起高效搭建精美产品文档
以上就是通过使用 Apifox 来进行产品文档维护的具体实践。除了以上提及的内容之外，我们也可以把产品帮助文档、开发者文档与 API 文档以一个风格进行维护并全部串联到一起，这样给你的用户的体验提升就更好了。如果你的实际情况比较适合，欢迎你参考此实践试试看，也可以推荐给其他小伙伴使用。期望能够为你的产品文档搭建工作带来一些效率、质量上的提升。
2025-03-13 14:34:38
915
原创 Apifox 2月更新｜调试 AI 接口时展示思考过程，团队内支持共享数据库连接
导入 OpenAPI/Swagger 格式的数据时，当 body 包含常见的文件、图片格式时，Apifox 会自动将其识别并导入为 Binary 类型，减少了手动调整的需求，让文件处理相关的接口定义更加准确。如果数据库地址、用户名、密码等信息是用「变量」填写的，那么这些信息可以在项目内同步，成员间可以协同使用，避免每个成员都需要独立配置的繁琐工作。更新到最新版本的 Apifox 后，调试 SSE 流式响应的 AI 大模型（如 OpenAI、Gemini、Claude 等）接口时，会自动合并消息内容，
2025-02-28 15:44:27
760
原创 Apifox 增强 AI 接口调试功能：展示 DeepSeek 思考过程、自动合并 SSE 响应
Apifox 最新版本增强了 AI 接口调试功能：自动合并 AI 接口的流式输出 + 展示 DeepSeek 思考过程！挑战全网最舒服的 SSE 响应 UI 渲染，让 AI 接口调试更便捷！
2025-02-18 14:04:47
1128
原创 如何在 Apifox 中一键调用 DeepSeek API？
来看看如何通过 Apifox 调用 DeepSeek API 吧！还附带高级功能拓展教程哦~
2025-02-12 14:24:35
1407
原创 Apifox 1月产品更新｜跨项目使用团队变量、支持配置 GA 统计、支持通过自托管请求代理 Agent 发送接口请求
Apifox 新版本上线啦！
2025-01-26 13:49:57
929
原创 使用 Apifox 发布的文档如何集成 Algolia 全文搜索？
如何在 Apifox 中为发布的文档集成 Algolia 搜索功能？超简单的教程来啦！
2025-01-15 14:18:50
718
原创 Apifox 12月更新｜接口的测试覆盖情况、测试场景支持修改记录、迭代分支能力升级、自定义项目角色权限、接口可评论
管理员可在团队或组织的「成员」页面中，自定义项目角色并配置对应的项目功能权限。设置完成后，可以在团队成员权限中指派角色具体成员，确保成员仅能访问与其职责相关的功能，实现精准的权限管理，从而提升项目安全性并优化协作效率。注：使用该功能需要升级为商业旗舰版。
2024-12-27 16:14:33
1122
原创 代码写得再好，为什么就是不想写 API 文档？
你写文档的时候，眼前的任务是做完接口开发，赶紧提交，测试通过，功能上线。并且前后端在接口开发时，往往是“各做各的”，导致接口文档常常没有和实际开发保持一致，反复调试，时间浪费不说，甚至可能影响上线进度。还能在具体的接口里面看到历史记录，看到是哪位开发在哪个时间点修改的，若要恢复到以前的版本也能一键还原。典型的就是后端开发定义了接口，但接口参数频繁更改，文档无法及时同步更新，前端开发看的是过时的数据。你以为写完了一个漂亮的接口文档，结果在开发和测试的过程中，接口不断变化，文档的维护几乎成了噩梦。
2024-12-12 11:07:32
1100
原创 Apifox 产品更新｜支持发布多个文档站、文档站支持 Algolia 搜索配置、从返回响应直接设置断言
我们升级了 Swagger/OpenAPI 文件的导入功能，返回响应的 Header 和描述支持「智能合并」和「指定字段覆盖」选项，使 API 文档的更新和维护变得更加灵活精确。最新版本的 Apifox 在「分享文档」模块内，将「发布文档」升级为「发布文档站」，能更便捷发布和管理接口文档，为团队协作和对外展示提供强大支持。根据用户反馈，我们解决了恢复上次退出 App 时未关闭标签页可能导致内存占用过高的问题，提升了性能，确保流畅的用户体验，同时减少系统资源压力。，便于面向不同渠道用户展示不同内容。
2024-12-12 10:32:35
1220
原创 理解 HTTP 请求中 Query 和 Body 的异同
HTTP请求是客户端（如浏览器）向服务器发送的消息，目的是请求资源或执行特定操作。URL：指定所请求资源的位置。头部（Headers）：包含请求的额外信息，如内容类型和认证详情。查询参数（Query）和请求体（Body）：用于传输数据。查询参数和请求体是 HTTP 请求中的两个基本组成部分，每个部分都有其独特的用途和特征。查询参数适用于传输小规模、简单的数据，通常用于 GET 请求；而请求体适用于大规模、复杂的数据传输，通常用于 POST、PUT 和 PATCH 请求。
2024-07-26 11:14:47
1791
原创 在 Apifox 中如何通过前后置操作获取当前接口请求参数？
要提取 Path 参数，可以使用 pm.request.url.path 方法获取包含所有路径名称的数组，这个数组按顺序包含 URL 中每个斜杠 / 后的路径名称，允许你通过数组索引精确定位到特定参数。要获取到接口请求的完整 URL，包括前置 URL、Path 参数和 Query 参数，可以使用 pm.request.url.toString() 方法。方法中的 request 是接口的请求对象，在「前置操作」中表示“即将发送的请求”，在「后置操作」中表示“已发送的请求”。
2024-07-24 11:26:54
3145
原创 什么是 API Token 以及如何使用它
API Token 是一种用于识别和验证 API 调用的安全凭证。当开发者或应用程序需要访问受保护的资源或服务时，他们会使用 API Token 进行身份验证。这个 Token 是一个独特的字符串，通常用作访问 API 的钥匙。简而言之，API Token 就像是一个可以打开特定保险箱的钥匙，只要拥有这个钥匙，就能访问保险箱内的资源。同样，API Token 使得应用程序能够确定请求的来源是否合法，并决定是否授予其访问权限。
2024-07-19 11:13:15
4420
原创 在 Apifox 中如何高效批量添加接口请求 Body 参数？
这样在创建类似接口时可以复用这些参数模板，最典型的就是添加「常用参数」和「数据模型」。
2024-07-17 13:42:12
3450
原创 Webhook 是什么？详解其工作原理
在现代技术中，一切都相互连接，每个应用程序通过许多服务的组合和协调实现无缝工作。这种协调是通过 webhooks 实现的。Webhooks 是基于的回调函数，其中一个服务使用 API 立即通知另一个服务发生的事件。这就是简单的版本。从技术上讲，根据最早概念化 webhooks 的的说法，webhooks 是 “使用 HTTP 进行的用户定义回调”。
2024-07-16 16:16:20
6219
原创 利用 API 接口进行自动代码生成的最佳实践
在 API 开发过程中，开发人员经常面对大量冗余代码的挑战。每个 API 都需要类似的验证逻辑、错误处理以及数据解析，这不仅消耗时间而且容易出错。
2024-07-12 11:08:24
1044
原创 SSE 和 WebSocket 的区别与选择指南
在选择适合自己项目的实时通信技术时，重要的是要根据应用的具体需要 —— 是需要简单的单向数据更新，还是复杂的双向交互。SSE 提供了一个易于实施的选择，适合更新频繁的数据流应用，而 WebSocket 则适用于更需求高效双向交互的场景。
2024-07-09 11:27:54
1643
原创 什么是 HTTP POST 请求？初学者指南与示范
通过以上讨论，我们了解到 POST 方法不仅在提交大型数据和敏感信息时提供了安全性，同时也允许开发者通过不同的技术实现灵活的数据交互。从 HTML 表单到复杂的 API 交互，POST 方法为现代网络应用的开发提供了强大的支持。
2024-07-05 11:57:04
5501
1
空空如也
空空如也
TA创建的收藏夹 TA关注的收藏夹
TA关注的人