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接口文档内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java实现一个扫描包的工具类实例代码

    java实现一个扫描包的工具类实例代码

    很多框架,比如springmvc,mybatis等使用注解,为了处理注解,必然要对包进行扫描,所以下面这篇文章主要给大家分享介绍了关于利用java如何实现一个扫描包的工具类,文中通过示例代码介绍的非常详细,需要的朋友可以参考下。
    2017-10-10
  • Java中的字节流InputStream和OutputStream详解

    Java中的字节流InputStream和OutputStream详解

    这篇文章主要介绍了Java中的字节流InputStream和OutputStream详解,继承自InputStream的流都是用于向程序中输入数据,且数据的单位为字节8bit,我们看到的具体的某一些管道,凡是以InputStream结尾的管道,都是以字节的形式向我们的程序输入数据,需要的朋友可以参考下
    2023-10-10
  • Springboot+netty实现Web聊天室

    Springboot+netty实现Web聊天室

    这篇文章主要介绍了利用springboot+netty实现一个简单Web聊天室,文中有非常详细的代码示例,对正在学习Java的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-12-12
  • 使用Spring Boot的LoggersEndpoint管理日志级别

    使用Spring Boot的LoggersEndpoint管理日志级别

    这篇文章主要为大家介绍了使用Spring Boot的LoggersEndpoint管理日志级别,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Java浅析枚举类的使用

    Java浅析枚举类的使用

    枚举类型可以取代以往常量的定义方式,即将常量封装在类或接口中。此外,枚举类型还提供了安全检查功能。本文就来和大家讲讲Java中枚举类的用法,需要的可以参考一下
    2022-07-07
  • 关于jpa querydsl嵌套查询demo

    关于jpa querydsl嵌套查询demo

    这篇文章主要介绍了关于jpa querydsl 嵌套查询demo,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • springboot查看和修改内置tomcat版本的方法步骤

    springboot查看和修改内置tomcat版本的方法步骤

    本文主要介绍了springboot查看和修改内置tomcat版本的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-07-07
  • 在Java中使用基本的正则表达式

    在Java中使用基本的正则表达式

    这篇文章主要介绍了在Java中使用基本的正则表达式,本文通过简要的案例,说明了很多场景下的正则表达式的用法,列出了正则表达式匹配规则的表格,需要的朋友可以参考下
    2021-07-07
  • 详解Java编程规约(命名风格、常量定义、代码格式)

    详解Java编程规约(命名风格、常量定义、代码格式)

    这篇文章主要介绍了详解Java编程规约(命名风格、常量定义、代码格式),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-10-10
  • MultipartFile文件判断是否存在的操作

    MultipartFile文件判断是否存在的操作

    这篇文章主要介绍了MultipartFile文件判断是否存在的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07

最新评论