Swagger配置
基本介绍
借助Swagger开源和专业工具集,为用户,团队和企业简化API开发。
新建一个工具类模块common
pom导入包
<!--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>
编写配置类
@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", "https://blog.csdn.net/ALin_Think", "@qq.com"))
.build();
}
}
业务所在层添加所配置的Swagger
<dependency>
<groupId>com.online</groupId>
<artifactId>service_base</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
Controller添加Swagger注解
@Api(description = "讲师管理")
@RestController
@RequestMapping("/eduservice/teacher")
public class EduTeacherController {
@Autowired
private EduTeacherService eduTeacherService;
/**
* 查询所有教师信息
* @return
*/
@ApiOperation(value = "所有讲师列表")
@GetMapping("findAll")
public List<EduTeacher> findAllTeacher(){
List<EduTeacher> list = eduTeacherService.list(null);
return list;
}
@ApiOperation(value = "逻辑删除讲师")
@DeleteMapping("{id}")
public boolean removeTeacher(@ApiParam(name ="id",value="讲师ID",required= true) @PathVariable String id){
boolean flag = eduTeacherService.removeById(id);
return flag;
}
}
Entity层添加注解
测试地址
http://localhost:8001/swagger-ui.html(本地项目的访问路径加swagger后缀)
测试结果