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

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

总结

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

您可能感兴趣的文章:

Flink流处理引擎零基础速通之数据的抽取篇
今天不分享基础概念知识了，来分享一个马上工作需要的场景，要做数据的抽取，不用kettle，想用flink。实际就是flink的sql、table层级的api
2022-05-05
使用Java构造和解析Json数据的两种方法(详解一)
JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式，采用完全独立于语言的文本格式，是理想的数据交换格式。接下来通过本文给大家介绍使用Java构造和解析Json数据的两种方法，需要的朋友参考下吧
2016-03-03
快速入门Java中的Lambda表达式
Lambda作为函数式编程中的基础部分，在其他编程语言中早就广为使用，但在Java领域中发展较慢，直到java8，才开始支持Lambda。网上关于Lambda的教程很多，今天小编给大家分享一篇快速入手Lambda的教程。
2016-08-08
Nett中的心跳机制与断线重连详解
这篇文章主要介绍了Nett中的心跳机制与断线重连详解,我们以客户端发送心跳为例,平时我们的心跳实现方式可能是搞个定时器,定时发送是吧,但是在Netty中却不一样,心跳被称为空闲检测,需要的朋友可以参考下
2023-12-12
Spring Boot的Maven插件Spring Boot Maven plu
Spring Boot的Maven插件Spring Boot Maven plugin以Maven的方式提供Spring Boot支持,Spring Boot Maven plugin将Spring Boot应用打包为可执行的jar或war文件,然后以通常的方式运行Spring Boot应用,本文介绍Spring Boot的Maven插件Spring Boot Maven plugin,一起看看吧
2024-01-01
@validated注解异常返回JSON值方式
这篇文章主要介绍了@validated注解异常返回JSON值方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10
SpringBoot中的@Import注解四种使用方式详解
这篇文章主要介绍了SpringBoot中的@Import注解四种使用方式详解,@Import注解只可以标注在类上,可以结合 @Configuration注解、ImportSelector、ImportBeanDefinitionRegistrar一起使用,也可以导入普通的类,需要的朋友可以参考下
2023-12-12
java对象类型转换和多态性(实例讲解)
下面小编就为大家带来一篇java对象类型转换和多态性(实例讲解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-10-10
Java Collections.sort()实现List排序的默认方法和自定义方法
这篇文章主要介绍了Java Collections.sort()实现List排序的默认方法和自定义方法,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2017-06-06
SpringBoot集成validation校验参数遇到的坑
这篇文章主要介绍了SpringBoot集成validation校验参数遇到的坑,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12