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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM