Swagger-的使用

前言

在我们和前端进行交互的时候,出接口文档是一件必须的事情,如果手写接口文档是一件很折磨人的事情,不管是前端还是后端开发,多多少少都会被接口文档所折磨,前端会抱怨后端没有及时更新接口文档,而后端又会觉得编写接口文档太过麻烦。通过swagger可以很好的解决这个问题

效果

在这里插入图片描述

1、相关依赖

在这里插入图片描述

<!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui -->
		<dependency>
			<groupId>org.springdoc</groupId>
			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
			<version>2.3.0</version>
		</dependency>

2、相关注解

在这里插入图片描述

2.1 @Tag设置整个类的名称和详情

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

2.2 @Operation描述具体的方法

在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

2.3 @Parameter 描述参数

在这里插入图片描述
在这里插入图片描述

2.4@Schema 为属性添加注释

在这里插入图片描述

在这里插入图片描述

3、Docket配置

3.1通过gropeediopenapi进行分组

在这里插入图片描述

在这里插入图片描述

3.2 通过docsOpenApi设置

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

相关推荐

  1. Express中使用Swagger

    2024-02-19 08:04:04       66 阅读
  2. Swagger使用配置笔记

    2024-02-19 08:04:04       40 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-02-19 08:04:04       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-02-19 08:04:04       101 阅读
  3. 在Django里面运行非项目文件

    2024-02-19 08:04:04       82 阅读
  4. Python语言-面向对象

    2024-02-19 08:04:04       91 阅读

热门阅读

  1. 2024阿里云服务器配置怎么选择?c7、g7和r7?

    2024-02-19 08:04:04       55 阅读
  2. 探索前端框架的世界:一场前端之旅

    2024-02-19 08:04:04       49 阅读
  3. 2.4.1.1 相机内参标定

    2024-02-19 08:04:04       55 阅读
  4. 【大数据面试题】008 谈一谈 Flink Slot 与 并行度

    2024-02-19 08:04:04       44 阅读
  5. 707 设计链表——dummyHead好用

    2024-02-19 08:04:04       48 阅读