SpringBoot整合Swagger3（OpenAPI3）⽣成接⼝⽂档
都说好记性不如烂笔头，每天写⼀点，从量变到质变的开始!废话不多说，以下所有内容均来⾃本⼈实际操作:
1.为什么使⽤Swagger3(OpenAPI3)?
介绍的功能太过复杂，作为⼀个后端开发，我们往往只需要⽤它来⾃动⽣成接⼝⽂档,⽽Swagger2早就不维护了，因此通过到了
springdoc-openapi Java库有助于使⽤Spring Boot项⽬⾃动⽣成API⽂档.springdoc-openapi的⼯作原理是在运⾏时检查应⽤程序，以基于spring配置，类结构和各种注释来推断API语义,⾃动⽣成JSON / YAML和HTML格式的API⽂档，可以使⽤swagger-api注释通过注释来完成本⽂档.
2.，添加OpenAPI依赖(不需要其他配置)
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.2</version>
</dependency>
3.启动项⽬访问试试()
4. 修改yml配置⽂件,⾃定义swagger配置
4.1 ⾃定义swagger访问html⾸页
springdoc:
swagger-ui:
path: /swagger/index.html
4.2 禁⽤springdoc-openapi
springdoc:
api-docs:
enabled: false
4.3 禁⽤swagger-ui
springdoc:
swagger-ui:
enabled: false
4.4 除了来⾃swagger-annotations的@Hidden注释之外，还可以使⽤程序包或路径配置来限制⽣成的OpenAPI描述
# Packages to include
springdoc.packagesToScan=com.package1, com.package2
# Paths to include
springdoc.pathsToMatch=/v1, /api/balance/**
4.5 springdoc-openapi核⼼属性
4.6  swagger-ui属性
springboot结构

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。