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页面信息,配置完变成了:

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

总结

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

相关文章

  • java分布式流处理组件Producer入门详解

    java分布式流处理组件Producer入门详解

    这篇文章主要为大家介绍了java分布式流处理组件Producer入门详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-03-03
  • MyBatis批量插入大量数据(1w以上)

    MyBatis批量插入大量数据(1w以上)

    MyBatis进行批量插入数时,一次性插入超过一千条的时候MyBatis开始报错,本文主要介绍了MyBatis批量插入大量数据的解决方法,感兴趣的可以了解一下
    2022-01-01
  • 通过实例了解Spring中@Profile的作用

    通过实例了解Spring中@Profile的作用

    这篇文章主要介绍了通过实例了解Spring中@Profile的作用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 通过Spring AOP实现异常捕捉机制

    通过Spring AOP实现异常捕捉机制

    在开发过程中,异常处理是一个不可忽视的重要环节,合理、优雅地处理异常不仅能提高代码的鲁棒性,还能提升系统的用户体验,本文将介绍如何通过Spring AOP实现一个高效的异常捕捉机制,使得异常处理变得更加优雅和统一,需要的朋友可以参考下
    2024-08-08
  • Spring Boot日志控制详解

    Spring Boot日志控制详解

    这篇文章主要为大家详细介绍了Spring Boot日志控制的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-11-11
  • Eclipse最新版使用过程中遇到的问题总结

    Eclipse最新版使用过程中遇到的问题总结

    这篇文章主要介绍了Eclipse最新版使用过程中遇到的问题总结的相关资料,本文通过图文并茂的形式给大家介绍的非常详细,具有参考借鉴价值,需要的朋友可以参考下
    2016-09-09
  • Spring 使用 feign时设置header信息的操作

    Spring 使用 feign时设置header信息的操作

    这篇文章主要介绍了Spring 使用 feign时设置header信息的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Netty源码分析NioEventLoop处理IO事件相关逻辑

    Netty源码分析NioEventLoop处理IO事件相关逻辑

    这篇文章主要介绍了Netty源码分析NioEventLoop处理IO事件相关逻辑,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-03-03
  • 详解Mybatis极其(最)简(好)单(用)的一个分页插件

    详解Mybatis极其(最)简(好)单(用)的一个分页插件

    这篇文章主要介绍了详解Mybatis极其(最)简(好)单(用)的一个分页插件,非常具有实用价值,需要的朋友可以参考下。
    2016-12-12
  • java判断对象中某个属性是否为空方法代码

    java判断对象中某个属性是否为空方法代码

    这篇文章主要给大家介绍了关于java判断对象中某个属性是否为空的相关资料,最近遇到后台接收值的时候,需要对接收对象进行非空校验,需要的朋友可以参考下
    2023-07-07

最新评论