springboot集成swagger详解
前言
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,而受开发者的欢迎。随着微服务的兴起,springboot集成swagger对于Java开发者是必须要掌握的,下面就来学习一下springboot集成swagger的步骤吧。
springboot集成swagger步骤
第一步:maven导入Swagger如下:
<!-- 添加使用swagger的依赖包 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<!-- 添加使用swagger的依赖包 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>
第二步:创建Swagger2配置类,如下所示:
/**
*
*/
package swagger.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @author ignore1992
*
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig
{
@Bean
public Docket createDocket()
{
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(createApiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("swagger.api.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo createApiInfo()
{
return new ApiInfoBuilder()
.title("springboot使用swagger2")
.description("生成对应接口文档")
.termsOfServiceUrl("https://blog.csdn.net/ignorewho")
.contact("ignore1992")
.version("1.0")
.build();
}
}
第三步:这样就可以使用swagger提供的注解,来完成描述,调用,生成等功能
常用注解如下:
@Api : 用在类上,说明该类的主要作用。
@ApiOperation:用在方法上,给API增加方法说明。
@ApiImplicitParams : 用在方法上,包含一组参数说明。
@ApiImplicitParam:用来注解来给方法入参增加说明。
/**
*
*/
package swagger.api.controller;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
/**
* @author ignore1992
*
*/
@RestController
@RequestMapping(value = "/swaggerapi")
public class SwaggerApiController
{
@ApiOperation(value = "测试swaggerapi接口方法")
@RequestMapping(value = "/test", method = RequestMethod.GET)
public String test()throws Exception
{
return "swaggerapi 测试";
}
}
总结
以上就是本文关于对springboot集成swagger的全部内容,希望对大家有所帮助。有什么问题可以随时留言,期待您的宝贵意见!
结束语
温馨提醒:如有技术问题以及资源失效请联系站长 QQ89549822 进行反馈!!!
您阅读本文耗时: 0小时02分35秒
上一篇: Java中Error和Exception的区别简介
下一篇: Hibernate中5个核心接口介绍
评论列表