# baseframework

**Repository Path**: rffanlab/baseframework

## Basic Information

- **Project Name**: baseframework
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: wd
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-06
- **Last Updated**: 2023-10-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 基础项目Jar包
添加了需要的基础框架的功能。该框架为小型项目准备。

# 使用方法（必须操作）
在新建的项目中，在运行文件中加入本包的扫描
首先 在pom中引入
```xml
    <dependency>
        <groupId>io.afu</groupId>
        <artifactId>baseframework</artifactId>
        <version>1.2.3</version>
    </dependency>

```
其次在application 中的注解扫描中添加包如下，如果不添加包扫描，包里面的配置很多都不会生效。包括各种spring boot相关的注解。
```java

@SpringBootApplication(scanBasePackages = {
        "你的项目的包名","io.afu"
})
public class TreasurebackApplication {

    public static void main(String[] args) {
        SpringApplication.run(TreasurebackApplication.class, args);
    }

}
```
开启项目Swagger的方法必须在application.yml中添加如下配置。开起之后，会扫描相关的@ApiOperation的注解
```yaml
swagger:
  enablesWagger: true # 这个为Swagger开启开关，设置为false之后Swagger就不会开启了。
  name: XX相关系统  # 不能为空
  title: XX相关系统 # 不能为空
  description: XXXX # 不能为空
  url: https://baseframework.afu.io # 不能为空
  email: admin@rffan.com  # 不能为空
  version: 0.1  # 不能为空
```
## 相关的方法和常量
| 操作                   |
|----------------------|
| [工具类](tools.md)      |
| [注解](annotations.md) |
| [枚举](enums.md)       |
| [其他](others.md)      |