# spring-boot-swagger-starter

**Repository Path**: crick/spring-boot-swagger-starter

## Basic Information

- **Project Name**: spring-boot-swagger-starter
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-03-14
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# spring-boot-swagger-starter
spring-boot项目快速添加swagger包括swagger-ui，用于管理接口文档以及页面调试
## 使用方法
**0.0.1已发布到maven中央仓库，欢迎使用**

```xml
    <dependency>
        <groupId>com.github.wangyuheng</groupId>
        <artifactId>swagger-starter</artifactId>
        <version>0.0.1</version>
    </dependency>
```

如果下载失败，可以发布starter到本地仓库
在**SwaggerStarter**目录执行

```
    mvn clean install 
```

此命令可以将jar添加进本地仓库

### 运行demo
在SwaggerStarterDemo目录执行

```
    mvn spring-boot:run 
```

可以启动spring-boot项目，默认端口号为**8080**,在浏览器访问[http://localhost:8080/](http://localhost:8080/),可以看到demo接口事例。
或者可以将项目导入常用IDE运行。
### 编辑配置文件
配置文件路径为 **spring-boot-swagger-starter/SwaggerStarterDemo/src/main/resources**，修改对应的配置项，重新启动可以在demo页面查看变动。

#### 配置参数

```yaml
    swagger:
      groupName: 分类(groupName)
      title: 标题(title)
      description: 介绍(description)
      termsOfServiceUrl: 服务URL(termsOfServiceUrl)
      version: 版本(version)
      contactName: 作者名(contactName)
      contactUrl: 作者主页(contactUrl)
      contactEmail: 作者邮箱(contactEmail)
      paths: /upload.*,/category.*
      license:
      licenseUrl:
```

## 设计
starter为方便项目使用，尽量简化，不添加无用依赖，自动化部分设置，留出配置文件方便定制化。