# only-common-action-description

**Repository Path**: onlylibrary/only-common-action-description

## Basic Information

- **Project Name**: only-common-action-description
- **Description**: 接口信息扫描
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 7
- **Created**: 2020-01-13
- **Last Updated**: 2025-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# only-common-action-description

#### 介绍
接口信息扫描,用于扫描spring mvc 或者其他接口信息，生成描述列表，可以用来生成接口文档

#### 使用方式
```
		1、使用示例
				DocumentService documentService = new DocumentService();
				
				// 如果需要识别自定义接口 可以扩展配置，然后添加配置即可
				// DocumentConfigurer c = new AwareDocumentConfigurerImpl();
				// c.config(documentService.getDocumentContext());
				
				// 扫描包目录，生成接口描述信息 如果classpath 下有源码，可以从源码注释得到各种信息
				// 如果没有源码，则需要com.onlyxiahui.common.action.description.annotation的注解实现
				List<ModuleData> list = documentService.scanPackages("com.onlyxiahui");
				
		2、Maven配置
				1)、对于本项目可以同步源码到classpath
				
				<!-- resource插件 -->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-resources-plugin</artifactId>
					<executions>
						<execution>
							<id>copy-resources</id>
							<phase>process-resources</phase>
							<goals>
								<goal>copy-resources</goal>
							</goals>
							<configuration>
								<outputDirectory>${project.build.outputDirectory}</outputDirectory>
								<resources>
									<resource>
										<directory>src/main/java</directory>
										<includes>
											<include>**/*.java</include>
										</includes>
									</resource>
								</resources>
							</configuration>
						</execution>
					</executions>
				</plugin>
				
				2)、对于外部jar依赖，可以同时把源码依赖进来
				<!-- 这是依赖 -->
				<dependency>
					<groupId>com.onlyxiahui.aware</groupId>
					<artifactId>aware-basic-bean</artifactId>
					<version>1.0.0</version>
				</dependency>
				<!-- 这是源码 -->
				<dependency>
					<groupId>com.onlyxiahui.aware</groupId>
					<artifactId>aware-basic-bean</artifactId>
					<version>1.0.0</version>
					<classifier>sources</classifier>
				</dependency>
				
				
```