# interface2jsonUtil

**Repository Path**: dream12345678/interface2json-util

## Basic Information

- **Project Name**: interface2jsonUtil
- **Description**: 平时要写的接口文档时要一个一个接口往上写，十分耗费时间，这个工具可以将spring中的注解RequestMapping进行识别，生成对应json类型的接口文档，然后一键导入
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-08-12
- **Last Updated**: 2023-08-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# interface2jsonUtil

#### 介绍
##### 接口文档生成
将springmvc中的路由识别，并且swagger生成对应json文件



#### 使用说明

1.按照下面图片使用即可，使用[PathDirector.java](src%2Fmain%2Fjava%2Fcom%2Fxiyuan%2Finterface2Json%2FPathDirector.java)类来build出解析器，输入你要解析的Controller类
![img.png](img.png)
生成的json文件
![img_1.png](img_1.png)
### 构建其他类型的json文件
继承[AbstractPathBuilder.java](src%2Fmain%2Fjava%2Fcom%2Fxiyuan%2Finterface2Json%2FAbstractPathBuilder.java)重写里面的构建json文件的方法

### 接口命名配置
[interface.yml](src%2Fmain%2Fresources%2Finterface.yml)中可以参考已有的配置

& 代表路径中同时包含 & 前后两个字符才算匹配成功

| 代表路径中同时包含 | 前后单个字符成功就算成功

### 配置解析器
![img_2.png](img_2.png)
这是其中一种方式，这会采用swagger的builder来创建对应的生成器

![img_3.png](img_3.png)
另外一种可以直接调用PathDirector有参构造来创建

优化这个项目？

0.重点可视化这个项目，采用vue（前后端分离）？javagui？

1.让配置项可以以可视化的形式配置。（配置接口命名规则）

2.先识别controller文件中所有的接口，让用户选择接口进行生成，并且可以改变这个接口的名称

3.识别参数的时候能不能通过方法里面调用的方法，从而找到真正的请求参数？