Torna 1.24.0 发布,接口文档解决方案

Torna 1.24.0 发布,本次发布内容如下:

【新增】

  • 支持查看文档变更记录,精确到字段级别,Markdown、富文本文档支持内容对比
  • 新增前置脚本、后置脚本,可在请求前动态处理参数信息
  • 新增文档状态字段(未开始、进行中、已完成),改状态支持钉钉推送
  • 文档内容变更支持推送到钉钉群,支持@某人
  • 支持自定义参数类型(下拉框可编辑)

【修复】

  • 未读消息只能显示10条问题

本次升级重点是查看文档变更记录,在文档预览界面右上角点击查看

弹出变更历史:

除此之外,富文本文档和Markdown文档支持内容对比

文档内容变更后支持推送到钉钉群

1.24.0版本新增请求预处理,可动态修改请求参数等信息,比如请求接口前获取一下token、参数加密

具体使用可以部署Torna进行体验~

关于 Torna

接口文档解决方案,目标是让接口文档管理变得更加方便、快捷。Torna 采用团队协作的方式管理和维护接口文档,将不同形式的文档纳入进来统一维护。

Torna 弥补了传统文档生成工具(如 swagger)的不如之处,在保持原有功能的前提下丰富并增强了一些实用的功能。

 

解决文档管理痛点

  • 不满足 swagger 文档预览页面和调试页面的展现方式
  • 不喜欢 swagger 这种侵入式注解
  • 希望使用 javadoc 注释生成文档,并进行接口调试
  • 希望把公司所有项目接口文档进行统一管理
  • 希望把项目中的若干文档提供给第三方调用者查看
  • 希望可以统一管理项目中的字典枚举

如果您有以上几个需求和痛点,或许可以尝试一下使用 Torna

快速开始

推荐组合

smart-doc + Torna 实现文档全流程自动化

如果您使用 Java 语言,推荐使用 smart-doc + Torna

smart-doc + Torna 组成行业领先的文档生成和管理解决方案,使用 smart-doc 无侵入完成 Java 源代码和注释提取生成 API 文档,自动将文档推送到 Torna 企业级接口文档管理平台。

通过这套组合您可以实现:只需要写完 Java 注释就能把接口信息推送到 Torna 平台,从而实现接口预览、接口调试。

推送的内容有:接口名称/author/Path参数/Header/请求参数/返回参数/字典列表/公共错误码

如果您是非 Java 语言,可以使用表单页面编辑以上内容,完成后同样可以进行接口预览、调试。

smart-doc 整合 Torna 图文教程

猜你喜欢

转载自www.oschina.net/news/267541/torna-1-24-0-released