關於springboot集成swagger及knife4j的增強問題

Posted on by

參考鏈接：狂神的Swagger筆記

  • 號稱世界上最流行的API框架
  • Restful Api 文檔在線自動生成器 => API 文檔 與API 定義同步更新
  • 直接運行，在線測試API
  • 支持多種語言 （如：Java，PHP等）
  • 官網：swagger

SpringBoot集成Swagger 添加maven依賴

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

 <dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
 </dependency>

要求：jdk 1.8 + 否則swagger2無法運行 要使用Swagger，我們需要編寫一個配置類-SwaggerConfig來配置 Swagger

package com.yf.exam.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

  //配置瞭swagger的Docket 的 bean 實例
  @Bean
  public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo());
  }
  //配置 swagger 信息 = apiInfo
  private ApiInfo apiInfo(){
    //作者信息
    Contact contact = new Contact("瀟七", "https://www.xhost.vip/", "[email protected]");
    return new ApiInfo("API文檔",
        "接口信息",
        "v1.0",
        
        contact,
        "Apache 2.0",
        "http://www.apache.org/licenses/LICENSE-2.0",
        new ArrayList()
    );
  }
}

訪問測試 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；
–

swagger界面

knife4j

官網參考地址：knife4j
knife4j是為Java MVC框架集成Swagger生成Api文檔的增強解決方案（在非Java項目中也提供瞭前端UI的增強解決方案），前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一樣小巧,輕量,並且功能強悍!

簡潔

基於左右菜單式的佈局方式,是更符合國人的操作習慣吧.文檔更清晰…

個性化配置

個性化配置項,支持接口地址、接口description屬性、UI增強等個性化配置功能…

增強

接口排序、Swagger資源保護、導出Markdown、參數緩存眾多強大功能.

SpringBoot集成Knife4j 添加maven依賴

<dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <!--在引用時請在maven中央倉庫搜索最新版本號-->
      <version>2.0.4</version>
 </dependency>

-訪問測試 ：http://localhost:8080/doc.html ，可以看到knife4j的界面；

knife4j界面

離線文檔導出

Knife4j提供導出4種格式的離線文檔(Html\Markdown\Word\Pdf)

到此這篇關於springboot集成swagger以及knife4j的增強的文章就介紹到這瞭,更多相關springboot集成swagger內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：