写点什么

Apifox 迭代更新:在线文档多格式导出、用户反馈问题优化,体验升级!

作者:Apifox
  • 2023-12-13
    广东
  • 本文字数:1598 字

    阅读完需:约 5 分钟

Apifox 迭代更新:在线文档多格式导出、用户反馈问题优化,体验升级!

Apifox 新版本上线啦!

看看本次版本更新主要涵盖的重点内容,有没有你所关注的功能特性:

  • HTTP 项目新增「迭代分支」功能

  • 支持通过数据库表直接生成 API 文档的数据模型

  • 在线文档支持多方式导出

  • 用户反馈问题优化数据库支持「测试连接」保持自动生成的字段顺序与定义一致支持 SQL 命令的语法高亮

01 HTTP 项目新增「迭代分支」功能

Apifox 新增了 HTTP 项目的迭代分支功能,支持迭代分支的创建、合并与管理,旨在提供灵活可控的 API 迭代协作机制,保证主分支稳定性的同时,提高团队工作效率。

点击项目名称右侧的分支 tab 可以创建独立分支,可以在该分支内设计、开发和测试新的接口,与主分支相互隔离,分支间的数据互不影响。待新接口开发完成并稳定后,可以将分支无缝合并到主分支,实现平滑升级,保证团队项目开发的稳定。

这非常适合快速迭代的团队,主要优点包括:

  • 主分支稳定:每个迭代分支包含独立的接口、数据模型、响应组件等数据,数据互不影响,保证主分支稳定性。

  • 协作并行:不同团队角色可在不同分支上同时工作,互不干扰,提升协作效率。

  • 快速合并:新分支开发完成后,可轻松快速地将迭代分支的内容合并回主分支。 

Apifox 的迭代分支管理机制为 HTTP 项目的协作开发提供了有力支持,实现了接口迭代化的独立空间与有序控制,使主分支可以保持稳定的同时,增强了 HTTP 项目团队的工作效率与协调性。



需要注意的是:

  1. 迭代分支功能目前处于 Beta 阶段,仅支持添加一个迭代分支。

  2. 迭代分支功能暂时不支持 自动化测试 和接口文档等功能,将在后续版本完善。

关于「迭代分支」功能的具体内容,可以前往 Apifox 官网帮助文档查看。**

02 支持通过数据库表直接生成数据模型

「通过 JSON 等生成」新增支持通过连接数据库的数据表,自动生成 API 文档的数据结构。只需配置连接数据库后,选择对应的数据库表和覆盖模式,即可一键自动生成数据结构,无需手动输入建表 SQL,大幅降低了创建和维护接口文档的工作量,实现了接口文档与数据库零偏差、高质量的同步。

目前已支持的数据库包括:

  • MySQL

  • SQL Server

  • Oracle

  • PostgreSQL

  • ClickHouse

  • 达梦数据库

  • MongoDB



03 在线文档支持多方式导出

在线文档除了可以导出 Apifox 格式,新增支持导出 OpenAPI/Swagger 文件和 HTML、Markdown 文档。用户和团队可以选择最符合工作流的文档格式,提升协作效率。



04 用户反馈问题优化

根据用户的反馈建议,我们对产品进行了优化升级。

数据库支持「测试连接」

Apifox 新增了数据库连接一键测试功能,在配置数据库连接参数后,用户可以点击「测试连接」按钮,实时验证数据库参数配置是否正确,避免在后续的数据库相关操作中报错。



保持自动生成的字段顺序与定义一致

Apifox 优化了根据数据结构自动生成内容时的字段顺序。现在生成的字段顺序会严格按照接口中定义的数据结构顺序生成,与请求参数保持一致,更符合用户习惯与预期。



支持 SQL 命令的语法高亮

新增 SQL 语句语法高亮显示功能,提高语句可读性,提升开发效率。



05 了解更多

当然,Apifox 产品团队为大家带来的新功能远不止上方这些:

  • 支持导入 Insomnia 的接口,包括 Scratch Pad 和 Collection

  • 数据库连接的 MongoDB 支持配置 Auth Source

  • 前/后置操作的脚本中支持通过 pm.variables.replaceInAsync 使用动态值

  • 优化 自动化测试 页面的性能,减少卡顿,提升流畅度

  • 自动化测试中使用提取变量功能,变量类型默认为「临时变量」

  • 通过数据模型生成代码时,可以搜索编程语言,且显示更多配置项

  • 在前/后置脚本选择数据库连接时,支持输入名称来筛选连接

  • 可以直接在目录树为接口添加用例

  • 支持导入 Apipost 新版 JSON 数据格式

  • 如果在线文档中引用了其他私有项目的图片,会给出更明确的错误提示

除了以上功能,我们也对产品其他细节和使用体验进行了优化,具体修改内容可前往 Apifox 更新日志查看

欢迎各位用户对 Apifox 继续提出使用反馈和优化意见,我们会持续优化更新,致力于为用户提供更优秀的产品功能和更极致的使用体验!

用户头像

Apifox

关注

Apifox 2022-05-17 加入

Apifox 是 API 文档、API 调试、API Mock、API 自动化测试一体化平台。Apifox = Postman + Swagger + Mock + JMeter

评论

发布
暂无评论
Apifox 迭代更新:在线文档多格式导出、用户反馈问题优化,体验升级!_程序员_Apifox_InfoQ写作社区