Springboot2.1.1集成swagger2.8.0

本文详细介绍如何在SpringBoot项目中集成Swagger2,包括引入依赖、配置类编写及控制器注解应用,帮助快速搭建API文档。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

引入依赖

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

通常和springboot web搭配

		<dependency>
		  <groupId>org.springframework.boot</groupId>
		  <artifactId>spring-boot-starter-web</artifactId>
		</dependency>

配置

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

  • swaggger 配置类
  • @author peter

*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {

public Docket restfulAPI() {
	return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
			.apis(RequestHandlerSelectors.basePackage("your controller package")).paths(PathSelectors.any())
			.build();
}

private ApiInfo apiInfo() {
	return new ApiInfoBuilder().title("your title").description("your description").termsOfServiceUrl("联系地址").version("1.0")
			.contact(new Contact("name", "url", "your email")).build();
}

}

应用

import javax.annotation.Resource;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

@RestController
@RequestMapping(“yourservice”)
@Api(“vin码服务接口”)
public class YourController {

@Resource
private YourNService service;

/**
 * 获取vin信息
 * @param vin
 * @return
 */
@ApiOperation(value = "xxx服务", httpMethod = "POST", notes = "xxx服务")
@ApiImplicitParams({@ApiImplicitParam( name = "name", value = "名称", required = true)})
@RequestMapping(value = "test", method = RequestMethod.POST)
public String test(String name) {
	return name;
}

}

启动项目后在浏览器中输入:http://localhost:8080/swagger-ui.html
找到对应的接口,点击try it out 调试
在这里插入图片描述
在请求模块输入值,点击【execute】按钮执行。
在这里插入图片描述

总结

集成三步骤
1、pom加入swagger依赖
2、工程实现swagger配置类
3、在controller中注解应用

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值