Torna 1.18.0 发布,企业接口文档解决方案

Torna 1.18.0 发布,本次更新内容如下:

  • 【新增】新增常量管理,可管理项目中的错误码、枚举信息
  • 【新增】导出文档的时候能够选择相应的环境 #I5SOET
  • 【修复】swagger query对象参数不显示;导入swagger树状类无限递归问题 pr
  • 【优化】优化LDAP登录
  • 【优化】优化部分UI
  • 【优化】手动修改文档描述后,再次推送不受影响,以手动调整为准
  • 【调整】之前的模块称呼调整为应用

项目首页新增常量管理,可统一维护项目中的错误码、枚举信息

现在导出文档可以选择对应的开发环境

导出成功后,效果如下图红色框所示:

 

关于 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 图文教程

优秀的个人博客,低调大师

微信关注我们

原文链接:https://www.oschina.net/news/216768/torna-1-18-0-released

转载内容版权归作者及来源网站所有!

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

相关文章

发表评论

资源下载

更多资源
优质分享Android(本站安卓app)

优质分享Android(本站安卓app)

近一个月的开发和优化,本站点的第一个app全新上线。该app采用极致压缩,本体才4.36MB。系统里面做了大量数据访问、缓存优化。方便用户在手机上查看文章。后续会推出HarmonyOS的适配版本。

Mario,低调大师唯一一个Java游戏作品

Mario,低调大师唯一一个Java游戏作品

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长,特征是大鼻子、头戴帽子、身穿背带裤,还留着胡子。与他的双胞胎兄弟路易基一起,长年担任任天堂的招牌角色。

Eclipse(集成开发环境)

Eclipse(集成开发环境)

Eclipse 是一个开放源代码的、基于Java的可扩展开发平台。就其本身而言,它只是一个框架和一组服务,用于通过插件组件构建开发环境。幸运的是,Eclipse 附带了一个标准的插件集,包括Java开发工具(Java Development Kit,JDK)。

Java Development Kit(Java开发工具)

Java Development Kit(Java开发工具)

JDK是 Java 语言的软件开发工具包,主要用于移动设备、嵌入式设备上的java应用程序。JDK是整个java开发的核心,它包含了JAVA的运行环境(JVM+Java系统类库)和JAVA工具。