springboot使用springfox-boot-starter创建swagger接口文档

官网说明
http://springfox.github.io/springfox/docs/current

添加maven依赖


org.springframework.boot
spring-boot-starter-web
2.3.5.RELEASE


io.springfox
springfox-boot-starter
3.0.0

示例Controller
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(value = “myApi”, tags = “API测试接口”)
public class MyController {

@ApiOperation("测试接口1")
@GetMapping("test1")
public String test1(@ApiParam("测试参数1") String test){
    return "test1";
}

@ApiOperation("测试接口2")
@GetMapping("test2")
public String test2(@ApiParam("测试参数2") String test){
    return "test2";
}

}

配置Swagger文档
简单配置
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger2Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(ApiInfo.DEFAULT);
}
}

API地址:http://localhost:8080/swagger-ui/index.html

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值