# springboot-swagger-demo

**Repository Path**: OHUHO/springboot-swagger-demo

## Basic Information

- **Project Name**: springboot-swagger-demo
- **Description**: SpringBoot 整合 Swagger2、OpenAPI3(Swagger3)、Knife4j 的 Demo
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2023-01-05
- **Last Updated**: 2024-04-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpringBoot-Swagger-Demo

> 项目说明：该demo为Spring Boot整合Swagger2、Swagger3（OpenAPI3）的参考案例，可供开发者参考即可快速使用。

|  模块名  | 介绍                                                         |
| :------: | :----------------------------------------------------------- |
| swagger2 | springboot整合swagger2，其中使用了swagger-bootsstrap-ui和knife4j-spring-ui的UI界面，Swagger2Config配置文件的代码同时对Swagger3也实用（代码中有相关注释）。在pom中选择对应的资源即可。注意：如果项目启动报错，请关注SpringBoot的版本，在配置文件中有说明。 |
| knife4j  | knife4j整合了swagger3（也就是我们通常说的OpenAPI3），使用的SpringBoot版本为3，需要保持JDK版本在17及其以上。我们虽然在项目中引用的依赖为knife4j-openapi3-jakarta-spring-boot-starter，但是配置的方法完全跟 openapi3相同。我们使用knife4j主要是想使用一些她的炫酷技能（增强特性）和中意于她的外表（ui）。 |

注意：使用时需要注意版本兼容问题，如果需要详细的接口文档配置信息，请在微信公众号【京茶吉鹿】中搜索 Swagger。

| ![Snipaste_2022-11-10_15-53-17](https://cdn.jsdelivr.net/gh/OHUHO/picture-bed/BlogImages/202301051812846.png) |
| :----------------------------------------------------------: |