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

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

MIT
Java 查看源码»
跨平台
2018-10-25
ayz6uem

前言

程序员一直以来都有一个烦恼,只想写代码,不想写文档。代码就表达了我的思想和灵魂。 Python提出了一个方案,叫docstring,来试图解决这个问题。即编写代码,同时也能写出文档,保持代码和文档的一致。docstring说白了就是一堆代码中的注释。Python的docstring可以通过help函数直接输出一份有格式的文档,本工具的思想与此类似。

代码即文档

Apiggs是一个非侵入的RestDoc文档生成工具。工具通过分析代码和注释,获取文档信息,生成RestDoc文档。

有这样一段代码

/**
 * Building a RESTful Web Service
 * 来自spring的官方示例:https://spring.io/guides/gs/rest-service/
 */
@RestController
public class GreetingController {

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

    /**
     * Web Endpoint greeting
     * @param name who is this
     * @return
     */
    @RequestMapping("/greeting")
    public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {
        return new Greeting(counter.incrementAndGet(),
                String.format(template, name));
    }
}

运行插件

gradle  运行  task: Tasks/documentation/apiggs

maven 运行  compile

生成文档

在编译目录下生成apiggs文件夹,并生成三个文件:

1. .json文件,可直接导入postman

1. .adoc文件,Asciidoc源文件

1. .html文件,源文件渲染结果,效果如下图

查看更多信息:Wiki

加载中

评论(9)

k
k_space
spring boot 工程,按步骤配置了下,没有输出什么文件呀
阿毛的故事
pom文件都没有怎么用maven
叫我刀刀
叫我刀刀
头像好评
ayz6uem
ayz6uem
更多参考 https://github.com/apiggs/apiggs
太黑_thj
太黑_thj
倒是给个使用教程啊??,从哪下载 ,或者maven仓库里面得资源名字是啥
hotsmile
hotsmile
对比swagger如何?
山空空
山空空
用的这个工具的maven插件 ,nl.jworks.markdown_to_asciidoc 找不到,并且下不下来。有谁遇到了吗???
久永
久永
只支持 java 语言吗?
feshfans
feshfans
赞一个,之前一直想有这样的工具

​Apiggs 发布 1.6 版本,支持复杂类型及已知 bug

Apiggs 是一个非侵入的 RestDoc 文档生成工具。工具通过分析代码和注释,获取文档信息,生成 RestDoc 文档。 1.6版本更新内容: 支持JSR303 支持Map 支持@bucket HTTP请求样例高亮 自定义htm...

11/09 13:46

Apiggs 1.4 发布,减少依赖包,修复一些 bug

Apiggs 1.4 发布了,更新如下: 实现自己的asciidoc构建器,移除对swagger2markup:markup-document-builder的依赖 实现自己的日志工具,移除对slf4j的依赖 支持@readme、@code、@title、@de...

10/30 09:03

没有更多内容

加载失败,请刷新页面

没有更多内容

暂无问答

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

前言 程序员一直以来都有一个烦恼,只想写代码,不想写文档。代码就表达了我的思想和灵魂。 Python提出了一个方案,叫docstring,来试图解决这个问题。即编写代码,同时也能写出文档,保持代...

10/25 09:11
17
0

没有更多内容

加载失败,请刷新页面

没有更多内容

返回顶部
顶部