# swagger-spring-boot-starter

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

## Basic Information

- **Project Name**: swagger-spring-boot-starter
- **Description**: 基于swagger 3的spring boot starter
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-21
- **Last Updated**: 2022-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 简介

基于Swagger 3的Spring Boot Starter，对代码零侵入，在配置文件中即可完成所有的配置。

**注意：**  
springfox官方提供了基于Spring Boot的[Starter](https://github.com/springfox/springfox)，如无自定义配置或者不喜欢用配置的方式可直接使用官方提供的Starter。

## 快速开始

Demo地址：https://gitee.com/imtc/swagger-spring-boot-starter-demo

### 添加依赖

在`pom.xml`中添加依赖：
```xml
<dependency>
    <groupId>cool.mtc</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>
```

### 配置项

在`application.yml`添加swagger相关配置：
```yaml
# Swagger
mtc:
  swagger:
    enabled: # 是否启用
    name: # 分组名称
    api: # 接口文档信息
      title: # 文档标题
      description: # 文档描述
      version: # 文档版本
      terms-of-service-url: # 服务条款URL
      license: # 许可证
      license-url: # 许可证URL
      contact: # 联系人信息
        name: # 联系人姓名
        url: # 联系人URL
        email: # 联系人邮箱
    base-package: # 提供接口的基础包名
    path-patterns: # 扫描的路径规则，语法：Ant Pattern
    exclude-path-patterns: # 排除扫描的路径规则，语法：Ant Pattern
    tags: # 标签列表
      - name: # 标签名
        description: # 标签描述
        order: # 标签顺序
    servers: # 服务提供者信息
      - url: # 服务提供者的地址，默认是当前项目的地址：http://ip:port/
        description: # 服务提供者描述
    global-parameters: # 全局参数
      - name: # 参数名称
        type: # 参数提交时位置类型，例：HEADER、COOKIE等，枚举类型（springfox.documentation.service.ParameterType）
        description: # 参数描述
        required: # 参数是否必传
    
    # 以上为没有分组的配置，如果有多个分组时，应使用以下配置
    groups: # 此节点配置和swagger节点配置基本一致
      - extended: # 在属性值未设置时，是否从swagger节点继承同一属性的值
        enabled: # 是否启用
        name: # 分组名称，
        api: # 接口文档信息（未配置时会从swagger节点继承）
        base-package: # 提供接口的基础包名（未配置时会从swagger节点继承）
        path-patterns: # 扫描的路径规则，语法：Ant Pattern（未配置时会从swagger节点继承）
        exclude-path-patterns: # 排除扫描的路径规则，语法：Ant Pattern（未配置时会从swagger节点继承）
        tags: # 标签列表（未配置时会从swagger节点继承）
        servers: # 服务提供者信息（未配置时会从swagger节点继承）
        global-parameters: # 全局参数（未配置时会从swagger节点继承）
```