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

最新推荐文章于 2023-03-07 17:49:18 发布

jar_wang

最新推荐文章于 2023-03-07 17:49:18 发布

阅读量2k

点赞数

CC 4.0 BY-SA版权

分类专栏： apiggs 文章标签： java restdoc doc api generator

本文链接：https://blog.youkuaiyun.com/w360188606/article/details/83374256

apiggs 专栏收录该内容

1 篇文章

订阅专栏

Apiggs是一款非侵入式的RestDoc文档生成工具，通过分析代码注释自动生成文档，保持代码与文档一致，适用于Python等语言。插件支持Gradle、Maven和IDEA，能生成JSON、Adoc和HTML格式的文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

程序员一直以来都有一个烦恼，只想写代码，不想写文档。代码就表达了我的思想和灵魂。

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));
    }
}