Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wangyuheng/spring-boot-swagger-starter
spring-boot项目快速添加swagger包括swagger-ui，用于管理接口文档以及页面调试
https://github.com/wangyuheng/spring-boot-swagger-starter
spring-boot starter swagger
Last synced: 3 months ago
JSON representation
spring-boot项目快速添加swagger包括swagger-ui，用于管理接口文档以及页面调试
- Host: GitHub
- URL: https://github.com/wangyuheng/spring-boot-swagger-starter
- Owner: wangyuheng
- License: mit
- Created: 2017-01-02T15:55:26.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-19T11:56:18.000Z (over 4 years ago)
- Last Synced: 2024-06-21T22:44:30.027Z (5 months ago)
- Topics: spring-boot, starter, swagger
- Language: Java
- Size: 48.8 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spring-boot-swagger-starter
spring-boot项目快速添加swagger包括swagger-ui，用于管理接口文档以及页面调试
## 使用方法
**0.0.1已发布到maven中央仓库，欢迎使用**
```xml
com.github.wangyuheng
swagger-starter
0.0.1
```
如果下载失败，可以发布starter到本地仓库
在**SwaggerStarter**目录执行
```
mvn clean install
```
此命令可以将jar添加进本地仓库
### 运行demo
在SwaggerStarterDemo目录执行
```
mvn spring-boot:run
```
可以启动spring-boot项目，默认端口号为**8080**,在浏览器访问[http://localhost:8080/](http://localhost:8080/),可以看到demo接口事例。
或者可以将项目导入常用IDE运行。
### 编辑配置文件
配置文件路径为 **spring-boot-swagger-starter/SwaggerStarterDemo/src/main/resources**，修改对应的配置项，重新启动可以在demo页面查看变动。
#### 配置参数
```yaml
swagger:
groupName: 分类(groupName)
title: 标题(title)
description: 介绍(description)
termsOfServiceUrl: 服务URL(termsOfServiceUrl)
version: 版本(version)
contactName: 作者名(contactName)
contactUrl: 作者主页(contactUrl)
contactEmail: 作者邮箱(contactEmail)
paths: /upload.*,/category.*
license:
licenseUrl:
```
## 设计
starter为方便项目使用，尽量简化，不添加无用依赖，自动化部分设置，留出配置文件方便定制化。