swagger

1.需要的依赖

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

2.配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi1")
                .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://atguigu.com", "55317332@qq.com"))
                .build();
    }

}

**

3、定义接口说明和参数说明

**
定义在类上：@Api
定义在方法上：@ApiOperation
定义在参数上：@ApiParam

@Api(description="老师管理")
@RestController
@RequestMapping("/teacher")
public class TeacherAdminController {
​
    @Autowired
    private TeacherService teacherService;
​
    @ApiOperation(value = "所有老师列表")
    @GetMapping("list")
    public List<Teacher> list(){
        return teacherService.list(null);
    }
​
    @ApiOperation(value = "根据ID删除老师")
    @DeleteMapping("delete/{id}")
    public boolean removeById(
            @ApiParam(name = "id", value = "老师ID", required = true)
            @PathVariable String id){
        return teacherService.removeById(id);
    }
}