???? Apiggs – 非侵入的RestDoc文档生成工具

45次阅读

共计 828 个字符，预计需要花费 3 分钟才能阅读完成。

前言
程序员一直以来都有一个烦恼，只想写代码，不想写文档。代码就表达了我的思想和灵魂。
Python 提出了一个方案，叫 docstring，来试图解决这个问题。即编写代码，同时也能写出文档，保持代码和文档的一致。docstring 说白了就是一堆代码中的注释。Python 的 docstring 可以通过 help 函数直接输出一份有格式的文档，本工具的思想与此类似。
代码即文档
Apiggs 是一个非侵入的 RestDoc 文档生成工具。工具通过分析代码和注释，获取文档信息，生成 RestDoc 文档。
引入插件

apiggs-gradle-plugin
apiggs-maven-plugin

有这样一段代码
/**
* 欢迎使用 Apiggs
* @index 1
*/
@RestController
public class GreetingController {

private static final String template = “Hello, %s!”;
private final AtomicLong counter = new AtomicLong();

/**
* 示例接口
* @param name 名称
* @return
*/
@RequestMapping(“/greeting”)
public Greeting greeting(@RequestParam(value=”name”, defaultValue=”apiggs”) String name) {
return new Greeting(counter.incrementAndGet(),
String.format(template, name));
}
}
运行插件
gradle 运行 task:
Tasks/documentation/apiggs
maven 运行
compile
生成文档
在编译目录下生成 apiggs 文件夹，并生成三个文件：