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("阿甘921341593@qq.com")
        .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);
    }
  }

5.访问路径:http://localhost:端口号/doc.html

posted @ 2021-09-30 10:50  921341593  阅读(354)  评论(0)    收藏  举报