swagger配置文件设置,设置扫描路径
时间: 2023-10-11 10:22:45 浏览: 154
在Swagger中,我们可以通过配置文件来设置扫描路径,以便让Swagger扫描到我们需要展示的接口和实体类。在Spring Boot项目中,我们可以在application.properties或application.yml文件中进行配置。
1. application.properties配置:
```
# Swagger配置
# 扫描的包路径
swagger.scan.base-package=com.example.demo
# API文档的标题
swagger.api.title=API文档
# API文档的描述
swagger.api.description=API文档描述
# API文档的版本号
swagger.api.version=1.0.0
# API文档的联系人
swagger.api.contact.name=联系人姓名
swagger.api.contact.url=联系人URL
swagger.api.contact.email=联系人邮箱
# 是否开启Swagger
swagger.enable=true
```
2. application.yml配置:
```
swagger:
# 扫描的包路径
scan:
base-package: com.example.demo
# API文档的标题
api:
title: API文档
# API文档的描述
description: API文档描述
# API文档的版本号
version: 1.0.0
# API文档的联系人
contact:
name: 联系人姓名
url: 联系人URL
email: 联系人邮箱
# 是否开启Swagger
enable: true
```
以上配置中,我们需要设置Swagger扫描的包路径,即`swagger.scan.base-package`或`swagger.scan.base-package`,设置API文档的标题、描述、版本号和联系人信息,以及是否启用Swagger。在设置好以上配置后,我们就可以启动项目并访问Swagger页面了。
阅读全文