springboot 集成swagger2

一、添加如下依赖:




   com.github.xiaoymin
   swagger-bootstrap-ui
   1.9.3



   io.springfox
   springfox-swagger2
   2.9.2
   
   
      swagger-models
      io.swagger
   
   
      swagger-annotations
      io.swagger
   




   io.swagger
   swagger-annotations
   1.5.21


   io.swagger
   swagger-models
   1.5.21

二、编辑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

springboot 集成swagger2_第1张图片

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

你可能感兴趣的:(java)