SpringBoot开启Swagger并配置基本信息方式

 更新时间:2024年05月22日 12:11:12   作者:yui方木  
这篇文章主要介绍了SpringBoot开启Swagger并配置基本信息方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

前后端分离:前后端交互:API

前后端集成联调,前后端人员无法及时协商

解决方案

  • 首先制定schema[计划的提纲],实时更新最新API,降低集成风险
  • Swagger

Swagger

  • 世界上最流行的API框架
  • Restful API 文档在线自动生成工具–>API文档与API定义同步更新
  • 可以在线直接运行,直接测试
  • 支持多种语言:Java、PHP…

在项目中使用swagger:springfox

  • swagger2
  • ui

Springboot集成Swagger

导包:

<!-- swagger -->
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>

配置swagger:

package com.example.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
/**开启Swagger2*/
@EnableSwagger2
public class SwaggerConfig {

}

然后就可以访问swagger页面: 

/swagger-ui.html

配置swagger

进ApiInfo这个类看看,有什么Api配置属性:

SwaggerConfig配置类:

配置ApiInfo:

@Configuration
/*开启Swagger2*/
@EnableSwagger2 /* :/swagger-ui.html */
public class SwaggerConfig {
//配置Swagger的Docket的bean实例
@Bean
public Docket docket(){
//配置文档信息
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

//配置apiinfo
private ApiInfo apiInfo(){

//作者信息
Contact contact = new Contact("fzl","https://blog.csdn.net/weixin_44976835","1403275028@qq.com");

return new ApiInfo(

"Epidemic Swagger",
"fzl最帅",
"1.0",
"https://blog.csdn.net/weixin_44976835",
contact,
"Apache 2.0",
"http://www.apache.org/licenses/LICENSE-2.0",
new ArrayList()
);

}
}

可以配置swagger-ui.html页面信息,配置完变成了:

没什么大用,就是更改一个文档说明,还能标注个作者什么的^ .^

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 一文带你掌握Spring Security框架的使用

    一文带你掌握Spring Security框架的使用

    Spring Security是一款基于Spring框架的认证和授权框架,提供了一系列控制访问和保护应用程序的功能,本文将会对Spring Security框架进行全面详细的讲解,需要的可以参考下
    2023-05-05
  • idea导入maven工程的三种方法

    idea导入maven工程的三种方法

    这篇文章主要介绍了idea导入maven工程的三种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • Spring-retry实现循环重试功能

    Spring-retry实现循环重试功能

    这篇文章主要介绍了Spring-retry 优雅的实现循环重试功能,通过@Retryable注解,优雅的实现循环重试功能,需要的朋友可以参考下
    2023-07-07
  • JDBC连接MySQL数据库批量插入数据过程详解

    JDBC连接MySQL数据库批量插入数据过程详解

    这篇文章主要介绍了JDBC连接MySQL数据库批量插入数据过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • Java 定时器的多种实现方式

    Java 定时器的多种实现方式

    本文介绍了Java中定时器的多种实现方式,有此需求的朋友可以根据实际选择适合自己的方式
    2021-06-06
  • Spring三级缓存解决循环依赖

    Spring三级缓存解决循环依赖

    本文主要介绍了Spring三级缓存解决循环依赖,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • Nacos心跳时间配置及服务快速上下线方式

    Nacos心跳时间配置及服务快速上下线方式

    这篇文章主要介绍了Nacos心跳时间配置及服务快速上下线方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 使用javax.sound实现简单音频播放

    使用javax.sound实现简单音频播放

    这篇文章主要为大家详细介绍了使用javax.sound实现简单音频播放,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • redis与spring整合使用的步骤实例教程

    redis与spring整合使用的步骤实例教程

    这篇文章主要给大家介绍了关于redis与spring整合使用的相关资料,文中通过示例代码将实现的步骤一步步介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-03-03
  • IDEA2022创建Maven Web项目教程(图文)

    IDEA2022创建Maven Web项目教程(图文)

    本文主要介绍了IDEA2022创建Maven Web项目教程,文中通过图文介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07

最新评论