# swagger-simple-starter

**Repository Path**: quanllong/swagger-simple-starter

## Basic Information

- **Project Name**: swagger-simple-starter
- **Description**: 自定义 Starter，帮助 Springboot 项目快速接入 Swagger2 

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-08-30
- **Last Updated**: 2023-08-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用步骤
## starter 编译
编译安装starter到本地maven仓库 ，进入starter目录执行
```
maven clean install
```

## 其它项目引入
springboot 项目在 pom 文件中添加
```xml
<dependencies>
    <dependency>
        <groupId>org.example</groupId>
        <artifactId>swagger-simple-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>
```
添加配置项
```yml
auto:
  swagger:
    enable: true
    title: 接口文档
    description: 接口文档desc
    basePackage: com.example.springbootdemo.controller
```

Swagger2启动成功日志
 ```
 Swagger2 init success.
 ```

访问地址
http://localhost:8081/swagger-ui.html#/

注意事项：
springboot版本 2.6.x 以下和swagger 2.9.2搭配使用，
高于 2.6.x 版本需增加兼容配置，详情 https://blog.csdn.net/hadues/article/details/123753888

Just have fun!