springboot整合knife4j全過程

更新時間：2023年12月08日 08:54:58 作者：qingkong2358103969

這篇文章主要介紹了springboot整合knife4j全過程,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

1.首先引用Knife4j的starter

Maven坐標如下：

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

2.以在配置文件中進行開啟

部分配置如下：

# springdoc-openapi項目配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.xiaominfo.knife4j.demo.web
# knife4j的增強配置，不需要增強可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

3.最后使用OpenAPI3的規(guī)范注解

注釋各個Spring的REST接口

示例代碼如下：

@RestController
@RequestMapping("body")
@Tag(name = "body參數(shù)")
public class BodyController {

   @Operation(summary = "普通body請求")
   @PostMapping("/body")
   public ResponseEntity<FileResp> body(@RequestBody FileResp fileResp){
       return ResponseEntity.ok(fileResp);
   }

   @Operation(summary = "普通body請求+Param+Header+Path")
   @Parameters({
           @Parameter(name = "id",description = "文件id",in = ParameterIn.PATH),
           @Parameter(name = "token",description = "請求token",required = true,in = ParameterIn.HEADER),
           @Parameter(name = "name",description = "文件名稱",required = true,in=ParameterIn.QUERY)
   })
   @PostMapping("/bodyParamHeaderPath/{id}")
   public ResponseEntity<FileResp> bodyParamHeaderPath(@PathVariable("id") String id,@RequestHeader("token") String token, @RequestParam("name")String name,@RequestBody FileResp fileResp){
       fileResp.setName(fileResp.getName()+",receiveName:"+name+",token:"+token+",pathID:"+id);
       return ResponseEntity.ok(fileResp);
   }
}

4.最后訪問Knife4j的文檔

地址：http://ip:port/doc.html即可查看文檔

注意的是：如果在配置文件中修改context-path信息，比如context-path: /imageanalyse,

那訪問地址就是http://ip:port//imageanalyse/doc.html

也可以建立一個默認基礎Controller，當請求路徑是/或者/swagger時，路由默認調(diào)轉(zhuǎn)到相對應的頁面上

@RestController
@Tag(name = "默認基礎Controller")
public class IndexController {


    @Value("${server.servlet.context-path:#{null}}")
    private String contextPath;

    /**
     * 自動跳轉(zhuǎn)Knife4j-UI地址
     * 
     * @param response
     * @throws IOException
     */
    @Operation(summary = "默認頁跳轉(zhuǎn)knife4j-ui")
    @GetMapping("/")
    public void index(HttpServletResponse response) throws IOException {
        String redirectPath="/doc.html";
        if(contextPath !=null && contextPath.length()>0){
            redirectPath = contextPath+redirectPath;
        }
        response.sendRedirect(redirectPath);
    }

    /**
     * 自動跳轉(zhuǎn)Swagger-UI地址
     * 
     * @param response
     * @throws IOException
     */
    @Operation(summary = "默認頁跳轉(zhuǎn)swagger-ui")
    @GetMapping("/swagger")
    public void swagger(HttpServletResponse response) throws IOException {
        String redirectPath="/swagger-ui/index.html";
        if(contextPath !=null && contextPath.length()>0){
            redirectPath = contextPath+redirectPath;
        }
        response.sendRedirect(redirectPath);
    }
}