SwaggerSpringBootStarter 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
SwaggerSpringBootStarter 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
SwaggerSpringBootStarter 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 Apache-2.0
操作系统 跨平台
软件类型 开源软件
所属分类 开发工具Java开发工具
开源组织
地区 国产
投 递 者 阿信sxq
适用人群 未知
收录时间 2017-07-21

软件简介

在spring-boot中使用swagger,可以实现对代码无侵入地集成swagger

使用时的项目配置

需要在spring boot项目中使用,下面按照使用maven构建项目,以使用application.properties文件来配置进行介绍, 如果使用其他的构建工具或配置文件,做相应的变更即可

在maven配置文件pom.xml中添加依赖

<dependency>
    <groupId>cn.songxinqiang</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>2.1.1.RELEASE</version>
</dependency>

application.properties文件中配置api的信息

#配置swagger的api信息
swagger.api.name = demo-api
swagger.api.title=Demo API
swagger.api.description=SwaggerSpringBootStarter 使用样例,一切就是这么简单
swagger.api.version=2.1.1
swagger.api.contact.name = 阿信sxq
swagger.api.contact.email = xinqiang.song@zycoo.com
swagger.api.contact.url = https://my.oschina.net/songxinqiang/
swagger.api.exclude-paths=/error,/admin/**

其中忽略路径使用英文逗号进行分隔,可以不进行配置

swagger ui在使用时的配置

api的控制器会监听在地址/v2/api-docs?group=<swagger.api.name配置的值>, 对于swagger ui来说需要指定服务器的“基础地址”为项目的根地址即可

需要单独准备swagger ui

可以使用maven坐标为

<dependency>
    <groupId>cn.songxinqiang</groupId>
    <artifactId>swagger-spring-boot-starter-ui</artifactId>
    <version>2.1.1.RELEASE</version>
</dependency>

的webjar

使用演示

说明博客: https://my.oschina.net/songxinqiang/blog/1490463

使用演示可以查看 https://gitee.com/songxinqiang/SpringBootSwaggerStarter-Demo

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击加入讨论🔥(1) 发布并加入讨论🔥
发表于服务端专区
2018/12/24 14:55

SwaggerSpringBootStarter 2.1.1 版本更新发布

SwaggerSpringBootStarter更新到2.1.1版本了,配套依赖spring boot 2.1.1版本。 对于spring boot的web项目,可以添加这个依赖方便地进行swagger的api 接口展示,不需要对代码进行任何修改,只需要添加依赖即可,甚至配置文件的配置也是可选的,可以添加到开发的包的构建配置中,那样就不会对正式包产生任何影响。 这个版本重构了api信息的构建代码,重新组织了配置文件,添加了对忽略路径的配置,解决了以往spring boot中类似于...

1
16
发表于服务端专区
2018/09/17 14:05

SpringBootSwaggerStarter 2.0.5 发布,补充 UI 文件

SpringBootSwaggerStarter,用于简化在spring boot的web项目中使用swagger展示api的操作,依据spring boot官方的命名建议,在maven中使用“swagger-spring-boot-starter”的坐标。 此次升级,将版本号与spring boot版本号同步,以后发布均会使用一致的版本号字符串。 从这个版本开始自带基本配置文件,可以不自己写配置了 这次还单独准备了一个附加的组件,用于准备swagger-ui的静态资源文件,添加依赖即可 <dependency>    ...

14
11
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
1 评论
38 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部