API 文档迁移至 ifBook 功能使用指引
创建 API 文档
在 ifBook 中创建 API 文档前，需将 API 登记到「API 设计」中进行线上化管理后可在接口文档中选择已登记的接口；接口登记后修改和创建对应测试用例也更便捷。
登记 API
「API 设计」中点击 + 新建或导入接口，导入支持 Postman 导入、Swagger 导入、HAR 导入、cURL 导入
录入接口后，支持对接口编辑、调试、创建接口用例、增加接口 Mock
创建公开文档
「公开文档」中新建公开文档，支持选择接口环境、允许调试、文档结构和安全设置
文档展示结构支持保持接口树和自定义文档结构
新建文档时文档展示结构字段选择“保持接口树现有结构”；接口文档展示时的目录层级和接口组织与 API 设计的结构保持一致
新建文档时文档展示结构字段选择“自定义文档结构”；支持自定义添加接口目录及目录下组织不同的接口
自动发布
暂不支持自动发布能力
配置测试环境
API 文档支持展示不同环境的接口，并能设置环境级的变量便于调试
接口文档中支持选择“接口环境”，环境寻址类型的接口，能根据不同环境加载对应请求地址
创建接口文档时支持选择环境
查看文档时支持切换不同环境，查看对应环境下的接口详情数据
设置接口 Mock
「Mock 管理」中新建 Mock 环境，支持 HTTP、gRPC 类型协议并可自定义 Mock 的域名
Mock 环境下支持添加多套 Mock 规则，规则识别支持“绑定接口”和“匹配路径”
“绑定接口”规则
“匹配路径”规则
响应参数设置，调试时符合规则的接口，会按照响应参数设置的值返回
问题反馈 >
2025-01-03最近更新感谢反馈有用
感谢反馈没用
在阅读中是否遇到以下问题？*
您希望我们如何改进？*
如果您希望得到回复，请留下您的邮箱地址。
