IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> Java知识库 -> springboot整合swagger3.0 -> 正文阅读

[Java知识库]springboot整合swagger3.0

目录

一、介绍及优点

二、项目中使用swagger

2.1 环境准备

? ? ? 1、新建:? springboot-web项目

??????2、导入springboot整合swagger的依赖

?3、配置swagger

?3.1、配置application.yml

3.2、启动类添加@EnableOpenApi或@EnableSwagger2

3.3、自定义文档信息

3.4、给实体类、字段、前端控制器、Api接口添加文档注解

3.5、注解使用场景:

三、使用

写在最后【以下内容与正文关系不大】:


一、介绍及优点

  • ??swagger是一个生成在线文档的API框架。
  • ? 可以使用生产的在线文档实时测试新增的接口。
  • ? 便于维护和前后端联调。

二、项目中使用swagger

需要两个组件的依赖:

  1. swagger
  2. swagger-ui

2.1 环境准备

springboot 2.7.0

swagger 3.0

? ? ? 1、新建:? springboot-web项目

????????????????传送门:使用IDEA新建一个springboot项目

??????2、导入springboot整合swagger的依赖

     <!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

?3、配置swagger

? ? ? ? 3.1配置application.yml、编写SwaggerConfiguration配置类、开注解。

? ? ? ? ?

?3.1、配置application.yml

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

3.2、启动类添加@EnableOpenApi或@EnableSwagger2

@SpringBootApplication
@EnableOpenApi
//@EnableSwagger2
public class DemoApplication {

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);
	}
}

随后启动项目访问:http://localhost:8080/swagger-ui/index.html

?在线文档大概可以分为以上四个部分;若不想使用默认的信息,则需要编写SwaggerConfiguration配置类进行个性化设置。

3.3、自定义文档信息

? ? ? ? 新建SwaggerConfiguration配置类,注册下Docket实例,使用源码里提供有参构造器来对文档页面自定义:

提供了以上可配置项、例如、SwaggerConfiguration配置类如下:

/**
 * @author Alex
 * @EnableSwagger2 开启swagger2
 */

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    /**
     * 配置Docket实例
     * @return
     */
    @Bean
    public Docket getDocket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(
                new ApiInfoBuilder()
                        .contact(new Contact("听钱塘信来","https://blog.csdn.net/chenyunjiangNN","123@qq.com"))
                        .title("Swagger在线文档")
                        .build()
                )
                .groupName("demo-project-123");
    }


}

效果:

?3.4、给实体类、字段、前端控制器、Api接口添加文档注解

?效果:

?

效果:

等等、总之对对于实体、字段、接口、查询参数添加描述、让前后端联调更方便。

3.5、注解使用场景:


@Api?? ?对请求Controller的说明
@ApiOperation?? ?方法的说明
@ApiImplicitParams?? ?方法参数的说明;
@ApiImplicitParam?? ?用于指定单个参数的说明。
@ApiResponses?? ?方法返回值的说明 ;
@ApiResponse?? ?用于指定单个参数的说明。
@ApiModel?? ?用在JavaBean类进行说明
@ApiModelProperty?? ?用在JavaBean类的属性进行说明

????????三、使用

根据接口信息给对应的参数值、执行后查看相应内容和状态码;比如下图的根据条件查询用户

此文中获取全部用户的接口是基于mybatis作为持久层实现的、此处就不一一说明了;

mybatis相关传送门:

springboot整合mybatis、springboot整合mybatis-plus? ?

填写对应参数后执行:

过程中报的一个异常:

Cannot invoke "org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.toString()" because the return value of "springfox.documentation.spi.service.contexts.Orderings.patternsCondition(springfox.documentation.RequestHandler)" is null

解决:

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

写在最后【以下内容与正文关系不大】:

问:?为什么访问:http://localhost:8080/swagger-ui/index.html会进入在线文档的页面?

答:我们进入springboot整合swagger的依赖看一下,已经包括了swagger-ui 3.0,无需单独引入swagger -ui 3.0的依赖;

在看一下swagger-ui3.0的依赖,就会找到index.html页面

问:前后端分离项目中、使用swagger在线文档有需要注意的地方吗?

答:有时会因为缓存导致文档不能实时更新、会导致配置、字段、Api接口之类的会有差别。说到底swagger在线文档只是提供测试接口和前后端协作的一个方案而已。不用过于依赖。

问:除了swagger-ui,还有其他第三方实现的在线文档吗?

        <!--   swagger-bootstrap-ui -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

页面:访问http://localhost:8080/doc.html

?

问:可以动态选取swagger文档在指定环境才能生效吗?

答:在Docket实例中、读取指定配置文件、拿到环境信息、注入enable(false)?即可关闭;

  Java知识库 最新文章
计算距离春节还有多长时间
系统开发系列 之WebService(spring框架+ma
springBoot+Cache(自定义有效时间配置)
SpringBoot整合mybatis实现增删改查、分页查
spring教程
SpringBoot+Vue实现美食交流网站的设计与实
虚拟机内存结构以及虚拟机中销毁和新建对象
SpringMVC---原理
小李同学: Java如何按多个字段分组
打印票据--java
上一篇文章      下一篇文章      查看所有文章
加:2022-10-17 12:18:51  更:2022-10-17 12:20:05 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2025年3日历 -2025/3/10 17:06:44-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码