1. 程式人生 > 其它 >knife4j+springboot快速整合

knife4j+springboot快速整合

1.版本資訊

  knife4j:2.0.7

  springboot:2.3.5.RELEASE

2.XML導包

  <dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>2.0.7</version>
  </dependency>

3.config配置

  @Configuration
  @EnableSwagger2WebMvc
  public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
      Docket docket=new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(new ApiInfoBuilder()
        //.title("swagger-bootstrap-ui-demo RESTful APIs")
        .description("# swagger-bootstrap-ui-demo RESTful APIs")
        .termsOfServiceUrl("http://www.xx.com/")
        .contact("[email protected]")
        .version("1.0")
        .build())
        //分組名稱
        .groupName("2.X版本")
        .select()
        //這裡指定Controller掃描包路徑
        .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
        .paths(PathSelectors.any())
        .build();
      return docket;
    }
  }

4.controller

  @Api(tags = "首頁模組")
  @RestController
  public class IndexController {


    @ApiImplicitParam(name = "name",value = "姓名",required = true)
    @ApiOperation(value = "向客人問好")
    @GetMapping("/sayHi")
    public ResponseEntity<String> sayHi(@RequestParam(value = "name")String name){
      return ResponseEntity.ok("Hi:"+name);
    }
  }