# Spring接口文档生成

**Repository Path**: blue__sky/spring-api-doc

## Basic Information

- **Project Name**: Spring接口文档生成
- **Description**: 扫描java源码的接口信息生成接口文档，一次性生成word、markdown、html、java测试类，自动生成变更内容，记录接口的增、删、改变化
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-07-13
- **Last Updated**: 2025-07-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# spring接口文档生成

#### 介绍
     从java源文件解析接口信息，用于生成更加灵活和直观的接口文档，也可以生成自定义的接口测试类。  
     可以只使用注释就能达到接口的详细标注，与java的注解解耦（比如swagger），间接减少一些三方包使用。    

##### 实现功能
  
1.    生成word文档、markdown文档、html文档、java测试类
2.    自动生成变更内容，记录接口和字段的增、删、改
3.    html文档为独立的页面（js、css整合在页面中），提供了在线测试功能
4.    支持注释方式与swagger注解同时生效
5.    支持模块的排序、分组、忽略，支持字段排序、示例值、忽略
6.    灵活控制哪些接口要生成，哪些接口不需要生成

#### 软件架构
  -    java  

#### 注释格式
 -    类注释  
```
  /**
     * 详细描述
     * @title 标题                       （不写时等于“详细描述”）  
     * @orderBy 999                      （排序，数字越大优先级越高）
     */   
```
 -    方法注释  
```
  /**
     * 详细描述
     * @ignore                         （写了会忽略该接口,不生成到文档）  
     * @title 标题                      （不写时等于“详细描述”）  
     * @param reqInfo                  （匿名参数可以不管,如json入参）  
     * @param username 用户名|必填      （“必填”可以用“Y”代替,非必填用“N”）  
     * @contentType application/json   （请求类型，参数未明确时手动指定）  
     * @dataType application/json      （返回类型，参数未明确时手动指定）  
     * @return 方法返回描述。
     * @orderBy 999                    （排序，数字越大优先级越高）
     */   
```
  -   对象字段注释
```
   /**
     * 详细描述
     * @ignore                          （写了会忽略该字段,不生成到文档）
     * @title 标题|Y|默认值示例          （不写时等于“详细描述”）
     */ 
```



#### 演示效果

1.    html文档  
直观展示 字段名与参数标题、默认值、是否必填
<img width="400" height="250" style="border: 1px solid #1A1A1A;" src="image/html%E6%96%87%E6%A1%A3.png" />   

支持在线测试（省去三方软件），请求参数也可进行导入和导出   
<img width="400" height="250" style="border: 1px solid #1A1A1A;" src="image/html%E5%9C%A8%E7%BA%BF%E6%B5%8B%E8%AF%95.png" />  

自动生成版本变更内容（只需要在生成时修改版本号）  
<img width="400" height="250" style="border: 1px solid #1A1A1A;" src="image/%E7%89%88%E6%9C%AC%E8%AE%B0%E5%BD%95.png" />  

2.    word文档
<img width="400" height="250" style="border: 1px solid #1A1A1A;" src="image/word%E6%96%87%E6%A1%A3.png" />

3.    markdown文档
<img width="400" height="250" style="border: 1px solid #1A1A1A;" src="image/markdown%E6%96%87%E6%A1%A3.png" />

4.    java测试类
<img width="400" height="250" style="border: 1px solid #1A1A1A;" src="image/java%E6%B5%8B%E8%AF%95%E7%B1%BB.png" />

#### 安装教程

-     下载项目，直接运行方法：  为了避免和源项目的依赖冲突，因此直接作为独立项目运行

<img width="400" height="250" style="border: 1px solid #1A1A1A;" src="image/%E5%B7%A5%E5%85%B7%E6%89%A7%E8%A1%8C%E5%85%A5%E5%8F%A3.png" />