???? Apigcc - 非侵入的RestDoc文档生成工具
前言--RestDoc
程序员一直以来都有一个烦恼，只想写代码，不想写文档。代码就表达了我的思想和灵魂。
Python提出了一个方案，叫docstring，来试图解决这个问题。即编写代码，同时也能写出文档，保持代码和文档的一致。docstring说白了就是一堆代码中的注释。Python的docstring可以通过help函数直接输出一份有格式的文档，本工具的思想与此类似。
代码即文档
Apigcc是一个非侵入的RestDoc文档生成工具。工具通过分析代码和注释，获取文档信息，生成RestDoc文档。
maven使用指南
1.引入对应依赖
<!-- https://mvnrepository.com/artifact/com.github.apiggs/apiggs --> <dependency> <groupId>com.github.apiggs</groupId> <artifactId>apiggs</artifactId> <version>1.6</version> </dependency>2.引入maven插件-配置
<plugin> <groupId>com.github.apiggs</groupId> <artifactId>apiggs-maven-plugin</artifactId> <version>1.6</version> <executions> <execution> <phase>compile</phase> <goals> <goal>apiggs</goal> </goals> </execution> </executions> <configuration> <!-- options in there --> <id>example</id> <version>${version}</version> <description>示例接口文档，使用默认模板</description> <title>示例接口文档</title> </configuration> </plugin>参数说明
- id 项目id，生成id.html等文件
- title 文档标题
- description 文档描述
- production 输出文件夹，默认为apiggs
- out 输出目录，默认为target
- source 源码目录，默认读取当前项目的src/main/java
- dependency 源码依赖的代码目录，以逗号隔开
- jar 源码依赖的jar包目录，以逗号隔开
- ignore 忽略某些类型，如UserDTO
- version 文档版本号
- css 设置html样式表
注意事项：
- 执行 mvn compile 需要clean install 时 请把插件注释掉 因为有冲突