• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

SpringBootSwaggerStarter: 在spring-boot中使用swagger,自动配置

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

SpringBootSwaggerStarter

开源软件地址:

https://gitee.com/songxinqiang/SpringBootSwaggerStarter

开源软件介绍:

SpringBootSwaggerStarter

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

使用时的项目配置

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

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

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

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

swagger.api.name = #api 的组信息swagger.api.title = #标题swagger.api.description = #描述信息swagger.api.version = #版本swagger.api.contact.name = #联系人名称swagger.api.contact.url = #联系人urlswagger.api.contact.email = #联系人邮箱swagger.api.exclude-paths = #忽略路径,英文逗号分隔

具体的使用,请查看开源中国博客的介绍

swagger ui在使用时的配置

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

或者可以直接添加依赖即可:

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

说明

本组件应对的是在使用Spring MVC时的场景,只会处理@Controller,@RequestMapping等其他与之关联的注解

基于springfox-swagger2,本组件只是简单的配置了一下下,感谢他们


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap