码云 IDEA 插件最新版本发布,支持 Pull Request

阿信sxq / SpringBootSwaggerStarterJavaApache-2.0

Metrics
0
Watch 24 Star 87 Fork 15
Sign up for free
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
在spring-boot中使用swagger,自动配置 spread retract

Loading...
README.md

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 = #联系人url
swagger.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,本组件只是简单的配置了一下下,感谢他们

Comments ( 6 )

You need to Sign in for post a comment

Help Search