Spring Boot2配置Swagger2生成API接口文档详情

 更新时间:2022年09月15日 14:09:02   作者:小二上酒8​​​​​​​  
这篇文章主要介绍了Spring Boot2配置Swagger2生成API接口文档详情,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下

一、Swagger2介绍

前后端分离开发模式中,api文档是最好的沟通方式。

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

  • 及时性(接口变更后,能够及时准确地通知相关前后端开发人员)
  • 规范性(并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)
  • 一致性(接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)
  • 可测性(直接在接口文档上进行测试,以方便理解业务)

二、配置Swagger2

1、引入相关依赖

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

2、创建swagger的配置类

@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("XX平台API文档")
.description("本文档描述了xxx接口定义")
.version("1.0")
// 创建人
.contact(new Contact("Jade", "http://jade.com", "55317362@qq.com"))
.build();
}
}

3、在启动类上添加注解扫描swagger的配置类,进行测试

要能扫描到swagger的配置类SwaggerConfig

@SpringBootApplication
// 要能扫描到swagger的配置类SwaggerConfig
@ComponentScan(basePackages = {"com.jade"})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}

4、API模型

可以添加一些自定义设置,例如:

定义样例数据

@ApiModelProperty(value = "创建时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;

@ApiModelProperty(value = "更新时间", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

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

  • 定义在类上:@Api
  • 定义在方法上:@ApiOperation
  • 定义在参数上:@ApiParam
@Api(description="讲师管理")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherAdminController {

@Autowired
private TeacherService teacherService;

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

@ApiOperation(value = "根据ID删除讲师")
@DeleteMapping("{id}")
public boolean removeById(
@ApiParam(name = "id", value = "讲师ID", required = true)
@PathVariable String id){
return teacherService.removeById(id);
}
}

6、测试,查看效果

访问http://localhost:8080/swagger-ui.html 即可

到此这篇关于Spring Boot2配置Swagger2生成API接口文档详情的文章就介绍到这了,更多相关Spring Boot2生成API接口文档内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • spring @Component注解原理解析

    spring @Component注解原理解析

    这篇文章主要介绍了spring @Component注解原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • Springboot集成ProtoBuf的实例

    Springboot集成ProtoBuf的实例

    这篇文章主要介绍了Springboot集成ProtoBuf的实例,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Mybatis中如何设置sqlSession自动提交

    Mybatis中如何设置sqlSession自动提交

    在MyBatis中,默认情况下,获取的SqlSession对象不会自动提交事务,这意味着在进行更新、删除或插入等操作后,需要显式调用commit方法来提交事务,但是,可以在获取SqlSession时通过将openSession方法的参数设置为true
    2024-09-09
  • SpringBoot整合ip2region获取客户端IP地理位置信息

    SpringBoot整合ip2region获取客户端IP地理位置信息

    在我们日常WEB开发工作中,经常会有需要获取客户端地理位置的需求,本文主要介绍了SpringBoot整合ip2region获取客户端IP地理位置信息,具有一定的参考价值,感兴趣的可以了解一下
    2024-08-08
  • java调用微信现金红包接口的心得与体会总结

    java调用微信现金红包接口的心得与体会总结

    这篇文章主要介绍了java调用微信现金红包接口的心得与体会总结,有需要的朋友可以了解一下。
    2016-11-11
  • Java之Thread的join方法实例

    Java之Thread的join方法实例

    这篇文章主要介绍了Java之Thread的join方法,实例形式讲述了join方法的应用,需要的朋友可以参考下
    2014-10-10
  • Spring中的事件监听器使用学习记录

    Spring中的事件监听器使用学习记录

    Spring框架中的事件监听机制是一种设计模式,它允许你定义和触发事件,同时允许其他组件监听这些事件并在事件发生时作出响应,这篇文章主要介绍了Spring中的事件监听器使用学习,需要的朋友可以参考下
    2024-07-07
  • Java基础教程之类数据与类方法

    Java基础教程之类数据与类方法

    这篇文章主要介绍了Java基础教程之类数据与类方法,本文是对类的深入探讨,类数据指类的一些属性、参数等,类方法就是类包含的功能方法,需要的朋友可以参考下
    2014-08-08
  • 总结Java对象被序列化的两种方法

    总结Java对象被序列化的两种方法

    今天给大家带来的是关于Java的相关知识,文章围绕着Java对象被序列化的两种方法展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • mybatis中关于type-aliases-package的使用

    mybatis中关于type-aliases-package的使用

    这篇文章主要介绍了mybatis中关于type-aliases-package的使用,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08

最新评论