最新最简练的Springboot集成Swagger

 一.config.xml引入swagger包

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
<version>1.9.1.RELEASE</version>
</dependency>

二.application.yml配置swagger

###swagger如下都是非必须的配置(实际使用时请根据实际情况配置)
swagger:
  enabled: true
  title: API文档
  description: XXX系统设计
  #接口包扫描路径
  base-package: com.system.demo.controller
  #需排除的接口路径
  exclude-path: /error/**
  version: ${project.version}

三.在类和方法,以及实体中添加swagger相关注解

@SpringBootApplication
@EnableSwagger2
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication .class, args);
    }

}
@Api(value = "测试swagger")
@RestController
@RequestMapping("/test")
public class TestController {

    @ApiOperation("测试swagger请求")
    @GetMapping("/{name}")
    public MyTest test(@PathVariable String name){
        MyTest myTest = MyTest.builder().myName(name).myAge(18).build();
        return myTest;
    }
}
@ApiModel("测试对象")
@TableName("t_my_test")
@Data@Builder@AllArgsConstructor
public class MyTest {
    @ApiModelProperty(value = "测试姓名",name = "username",example = "jack")
    private String myName;
    @ApiModelProperty(value = "测试年龄",name = "age",example = "18")
    private Integer myAge;
}

 四.测试

localhost:8082/swagger-ui.html进入swagger界面,选择对应方法,输入参数后,点击“Execute”即可

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值