Torna 1.2.0 发布，企业接口文档解决方案

内容简介：Torna 1.2.0 发布，本次更新内容如下： [feat]新增全局请求参数 [feat]新增全局返回参数 [refactor]优化字典管理交互 [refactor]优化模块设置交互 [refactor]优化加载文档性能问题 本次更新重点是新增全局请求参数...

Torna 1.2.0 发布，本次更新内容如下：

• [feat]新增全局请求参数
• [feat]新增全局返回参数
• [refactor]优化字典管理交互
• [refactor]优化模块设置交互
• [refactor]优化加载文档性能问题

本次更新重点是新增全局请求参数和全局返回参数

全局请求参数

设置了全局请求参数，每个接口请求都要带上这个参数，设置方式：前往模块配置 -> 全局请求参数进行配置

设置完毕后访问文档浏览页，请求参数列表中都会出现配置的全局请求参数。

全局返回参数

全局返回参数配置方式同全局请求参数一样，只不过这里多了数据节点。

• 为何要数据节点？

假如您的项目使用AOP技术做到统一结果返回，如：

{
    "code": "1000",
    "msg": "success",
    "data": {...}
}

其中，code, msg, data部分属于全局返回参数，{...}属于业务参数。

假设controller只返回业务结果

@RequestMapping("/findAll")
public List<User> findAll(){
    return userService.list();
}

在这种情况下，可以配置全局返回参数，然后指定数据节点，具体操作方式如下：

前往模块配置 -> 全局返回参数，点击添加

填写表单

这里顺便指定了关联枚举，用来解释各个code值，可以事先前往字典管理进行配置

接着使用同样的方式添加msg字段。

最后添加data字段，因为data字段是数据节点，需要设置为数据节点。

前往文档浏览页，展示结果如下：

 

关于Torna

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

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

• Torna 1.0.0 发布，企业接口文档解决方案
• Torna 1.1.0 发布，企业接口文档解决方案
• Torna 1.3.0 发布，企业接口文档解决方案
• Torna 1.3.3 发布，企业接口文档解决方案
• Torna 1.4.0 发布，企业接口文档解决方案
• Torna 1.4.2 发布，企业接口文档解决方案

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。