README.md · Gitee 极速下载/Apiggs - Gitee.com

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

文件

此仓库是为了提升国内下载速度的镜像仓库，每日同步一次。原始仓库： https://github.com/apiggs/apiggs

克隆/下载

README.md 1.37 KB

一键复制原始数据按行查看历史

提交于 2019-08-03 17:31 +08:00 . 更新说明，加入hub

# 🐷 Apigcc - 非侵入的RestDoc文档生成工具

![](https://img.shields.io/badge/Language-Java-yellow.svg)

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

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

### 代码即文档

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

### 有这样一段代码

```java
/**
 * 欢迎使用Apigcc
 * @index 1
 */
@RestController
public class HelloController {

    /**
     * 示例接口
     * @param name 名称
     * @return
     */
    @RequestMapping("/greeting")
    public HelloDTO greeting(@RequestParam(defaultValue="apigcc") String name) {
        return new HelloDTO("hello "+name);
    }

}
```


### 生成文档效果
![示例](https://apigcc-1252473972.cos.ap-shanghai.myqcloud.com/apigcc-hub-demo.png)

### 使用方式

[Hub](https://github.com/apigcc/apigcc-hub)

[Gradle插件](https://github.com/apigcc/apigcc-gradle-plugin)

[Maven插件](https://github.com/apigcc/apigcc-maven-plugin)

Loading...

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

1

https://gitee.com/mirrors/Apiggs.git

git@gitee.com:mirrors/Apiggs.git

mirrors

Apiggs

Apiggs

master