Torna IDEA 插件 0.1.5 发布,一键生成API文档

0 阅读2分钟

Torna IDEA 插件 0.1.5 发布,本次更新内容:

  • 修复扫描源码报错问题
  • 修复windows下乱码问题

关于Torna IDEA插件

Torna平台配套IDEA插件,一键生成本地SpringMVC接口文档。无需其它依赖(如swagger),开发者只需要维护Java注释即可。

功能特性

  • 支持springmvc接口推送
  • 支持solon框架接口推送
  • 支持dubbo接口推送
  • 支持接口分类管理
  • 支持配置文件继承
  • 支持第三方jar源码扫描
  • 支持重写第三方jar包类的字段描述和示列
  • 支持隐藏第三方jar包类的字段
  • 支持接口/字段隐藏
  • 全局定义默认示例值
  • 全局定义枚举字段code
  • 支持重写通用返回类(Result<T>)描述/示例值
  • 支持枚举描述国际化
  • 支持cli方式推送

使用方式:

比如有个接口定义如下:

/**
 * 产品模块(文件夹名称)
 *
 * @author thc(维护人)
 */@RestController@RequestMapping("shop/product")public class ProductController {

    /**
     * 查询产品(文档标题)
     * @apiNote 【选填】文档详细描述,吧啦吧啦
     * @param productNo 产品id*123
     * @return
     */
    @GetMapping
    public Result<ProductVO> get(@RequestParam Integer productNo) {
        ProductVO productVO = new ProductVO();
        productVO.setProductNo(String.valueOf(productNo));
        return Result.ok(productVO);
    }

}
  • 部署Torna
  • 安装maven并配置环境变量(执行mvn -v成功即可)

在 src/main/resources 目录下创建 torna.yml 配置文件

# Torna 推送地址
url: http://localhost:7700/api
# Torna 推送 token
token: "xx"
# 推送人,如果为空,则获取当前电脑用户名
author: ""

# 调试模式,true:打印推送内容
debug: false

下载 torna-plugin-idea-xxx.zip ,下载后不用解压

打开IEDA插件下载页面,点击齿轮->从本地磁盘安装,选择下载的zip

img

如何使用:右键Java文件或包名

img

  • 方式1:右键Java文件点击 Push Doc(推送类中所有接口)
  • 方式2:右键包名 Push Doc(推送包下所有接口)
  • 方式3:打开Java文件,类名处右键 Push Doc(推送类中所有接口)
  • 方式4:打开Java文件,接口方法名处右键 Push Doc(推送当前接口)

详情查看:文档推送