# stu-swagger2

**Repository Path**: OverCoding/stu-swagger2

## Basic Information

- **Project Name**: stu-swagger2
- **Description**: 学习swagger工具的测试代码
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-13
- **Last Updated**: 2020-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 1、配置pom.xml
在pom.xml中添加如下配置：
```xml
<!--引入swagger2-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<!--引入swagger-ui-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
```

### 2、创建配置类
* 创建 SwaggerConfig 类
* 配置开启Swagger注解 @EnableSwagger2
* 设置Swagger配置
```java
@Configuration
//开启swagger
@EnableSwagger2
//当swagger.enable为true时此配置类才生效
@ConditionalOnExpression("${swagger.enable:true}")
public class SwaggerConfig {

    /**
     * 配置swagger摘要信息
     * @return
     */
    @Bean
    public Docket docket(){
        //创建摘要对象，配置使用的规范版本
        return new Docket(DocumentationType.SPRING_WEB)
                //配置api基本信息
                .apiInfo(apiInfo())
                //创建一个构建器
                .select()
                //定义要包含的类（控制器和模型类）
                .apis(RequestHandlerSelectors.basePackage("com.ld.swagger"))
                //允许根据路径映射定义应包含哪个控制器的方法
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建ApiInfo对象，配置基本信息
     * @return
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("测试swagger系统")
                .description("学习swagger工具")
                .termsOfServiceUrl("https://lingfeng1024.gitee.io/blog/")
                .contact(new Contact("ld","https://lingfeng1024.gitee.io/blog/","13218018023@163.com"))
                .version("1.0")
                .build();
    }
}
```

### 3、配置application.yml
```yml
#配置是否启动swagger
swagger:
  enable: true
```

### 4、访问地址
启动程序，访问如下地址：
> http://localhost:8080/swagger-ui.html


### 5、引用其他ui
1. 修改pom.xml
    ```xml
    <!--引入swagger2-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    
    <!--引入swagger-ui-->
    <!--<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>-->
    
    <!--引入新的swagger-ui-->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-spring-ui</artifactId>
        <version>2.0.4</version>
    </dependency>
    ```
   
2. 启动项目，访问如下地址
> http://localhost:8080/doc.html