springboot集成swagger2

好久没写博客了,近期闲来无事,所以利用这个时间记录下工作中常用到的工具之一swagger。

Swagger是一个流行的API开发框架,整合了RESTful风格与SpringMVC的特点。这个框架以“开放API声明”(OpenAPI Specification,OAS)为基础,对整个API的开发周期都提供了相应的解决方案,是一个非常庞大的项目(包括设计、编码和测试,几乎支持所有语言)。

那么maven项目怎样集成swagger的呢?

首先引入swagger依赖,

		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
		</dependency>

然后写swagger配置类,代码如下:

@EnableSwagger2
@Configuration
public class SwaggerUIConfig {

	@Bean
	public SwaggerProperties swaggerProperties() {
		return new SwaggerProperties();
	}
	
	@Bean
	public Docket api() {
		return new Docket(DocumentationType.SWAGGER_2)
				.enable(swaggerProperties().isEnable())
				.groupName("...服务系统").apiInfo(apiInfo()).select()
				.apis(RequestHandlerSelectors.basePackage(SwaggerUIConfig.PACKAGE)).paths(PathSelectors.any())
				.build();
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("...服务")
				.description("...服务系统")
				.version("v1.0").build();
	}
	
	private static final String PACKAGE= "com.cn.cdm.controller";
}

如果是多环境开发,就再引入一个配置类如下图所示

在开发/测试环境配置文件中写对应的key-value如:carrefour.swagger.enable=true 

如图所示:

这样,多环境下的swagger相关配置就完成了。

相关的类、方法、入参注解这里就简单介绍下:

@Api()用于类; 表示标识这个类是swagger的资源   
@ApiOperation()用于方法; 表示一个http请求的操作

@ApiModelProperty()多用于实体方法,字段 表示对model属性的说明或者数据操作更改 

@ApiParam()用于方法,参数,字段说明(其实入参有多种写法,根据业务需求不同,可以用相应的注解,这里就不细说了大家自行百度下吧

swagger页面访问路径:http://localhost:8080/swagger-ui.html

效果如下

 

 

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

纯洁的一笑

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值