# annotation-reflect-test

**Repository Path**: li35619081/annotation-reflect-test

## Basic Information

- **Project Name**: annotation-reflect-test
- **Description**: 1、扫描包下的controller注解类 
2、扫描controller类型下RequestMapping注解的方法 
3、获取方法的请求参数类，并获取参数类中的非静态参数 
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2017-08-03
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

项目中需要写API接口文档。
目前已经使用过swagger 但是swagger具有局限性 
1、现网不可能开放swagger
2、接口没有具体说明，返回参数没用说明属性

这边写了了一个自定义扫描的。
使用场景：
	1、扫描包下的controller注解类
	2、扫描controller类型下RequestMapping注解的方法
    3、获取方法的请求参数类，并获取参数类中的非静态参数
    4、获取方法的返回参数，并获取参数类中的非静态参数（尚未实现）
可以生成以下文档

```

1[first]
---
###1.1接口说明[first]
|包名|类名|方法名|参数名|
|-----------|-----------|-----------|-----------|
|com.test|TestController|queryFirst|QueryFirstRequest|
###1.2输入参数
|名称|类型
|-----------|-----------|
|name|String|
|first|String|
```

1[first]
---
###1.1接口说明[first]
|包名|类名|方法名|参数名|
|-----------|-----------|-----------|-----------|
|com.test|TestController|queryFirst|QueryFirstRequest|
###1.2输入参数
|名称|类型
|-----------|-----------|
|name|String|
|first|String|