Boot整合Swagger

目录

一、导入相关依赖

二、编写swagger的配置类

三、启动输入地址，即可看到可视化界面

四、如上图，中文提示配置

 

---

一、导入相关依赖

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <scope>provided </scope>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <scope>provided </scope>
</dependency>

二、编写swagger的配置类

package com.cdu.baseservice.config;

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("Helen", "http://cdu.com", "132564@qq.com"))
                .build();
    }
}

三、启动输入地址，即可看到可视化界面

地址栏输入：项目地址/swagger-ui.html

如：http://localhost:8001/swagger-ui.html

四、如上图，中文提示配置

 

在controller上加：

@Api(description="讲师管理")

在方法上加：

@ApiOperation(value = "所有讲师列表")

在参数上加：

@ApiParam(name = "id", value = "讲师ID", required = true)