4.整合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

/**
 * Copyright (c) 2020 ucsmy.com, All rights reserved.
 */
package com.gunsmoke.servicebase;

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("java", "http://gunsmoke.com", "[email protected]"))
                .build();
    }
}

配置后的项目结构为

在controller所在的启动类中配置swagger

@SpringBootApplication
@ComponentScan(basePackages = {"com.gunsmoke"})
public class EduMain
{
    public static void main(String[] args) {
        SpringApplication.run(EduMain.class,args);
    }
}

注意，在service_edu工程的pom.xml文件中需要引入service_base

controller类中的相关写法

@Api(description = "讲师管理")
@RestController
@RequestMapping("/eduservice/edu-teacher")
public class EduTeacherController {

    @Autowired
    private EduTeacherService teacherService;

    @ApiOperation(value = "查询所有讲师列表")
    @GetMapping("findAll")
    public List<EduTeacher> findAllTeacher()
    {
        List<EduTeacher> list = teacherService.list(null);
        return  list;
    }

}

查看效果

本地访问http://localhost:8081/swagger-ui.html即可看到效果