温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

springboot集成swagger的步骤是什么

发布时间:2021-11-02 11:45:44 阅读:154 作者:iii 栏目:编程语言
开发者测试专用服务器限时活动,0元免费领,库存有限,领完即止! 点击查看>>

这篇文章主要介绍“springboot集成swagger的步骤是什么”,在日常操作中,相信很多人在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@EnableSwagger2public 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的步骤是什么”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注亿速云网站,小编会继续努力为大家带来更多实用的文章!

亿速云「云服务器」,即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘,价格低至29元/月。点击查看>>

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI

开发者交流群×