springboot 集成swagger2

一、添加如下依赖:

<!--swagger config -->
<!--引入ui包-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.3</version>
</dependency>

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
   <exclusions>
   <exclusion>
      <artifactId>swagger-models</artifactId>
      <groupId>io.swagger</groupId>
   </exclusion>
   <exclusion>
      <artifactId>swagger-annotations</artifactId>
      <groupId>io.swagger</groupId>
   </exclusion>
</exclusions>
</dependency>

<dependency>
   <groupId>io.swagger</groupId>
   <artifactId>swagger-annotations</artifactId>
   <version>1.5.21</version>
</dependency>
<dependency>
   <groupId>io.swagger</groupId>
   <artifactId>swagger-models</artifactId>
   <version>1.5.21</version>
</dependency>

二、编辑SwaggerConfig:

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("springboot 调用 Azkaban APi")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.javaazkaban.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Azkaban api use")
                .description("Springboot 整合Azkaban")
                .version("1.0")
                .build();
    }
}

三、配置controller上的注解:

@RestController
@RequestMapping("/api/azkaban")
@Api(tags = "Azkaban api use")
public class AzkController{

    @Autowired
    private AzkService azkService;

    @ApiModelProperty(value = "登陆Azkaban")
    @GetMapping("/login")
    public Boolean login() throws Exception {
        return azkService.login();
    }

四、启动程序,访问地址如下:

http://localhost:8080/doc.html

注:以上只是一个例子搭建使用swagger的案例,具体swagger其它的注解使用可以百度一下其它博客,本篇也主要是用于个人留档!!方便后续使用

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值