knife4j只用此插件的最簡潔開發方式

一、POM添加

在pom文件里添加包

<!--引入knife4j以來--> 
<dependency> 
<groupId>com.github.xiaoymin</groupId> 
<artifactId>knife4j-spring-boot-starter</artifactId> <version>1.9.6</version> 
</dependency>

二、配置添加，相當於<bean>添加

package com.mrliu.undertow.conf;

import com.github.xiaoymin.knife4j.spring.annotations.EnableSwaggerBootstrapUi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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;

/**
 * @author liuyang
 */
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUi
public class Swagger2Config {

    /**
     * 創建連接的包信息
     * <p>
     * 配置統一返回的controller路徑RequestHandlerSelectors.basePackage
     *
     * @return 返回創建狀況
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.mrliu.undertow.controller"))
                .paths(PathSelectors.any())
                .build();

    }


    /**
     * 設置文檔信息主頁的內容說明
     *
     * @return 文檔信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Project textBook API ")
                .description("服務接口")
                .termsOfServiceUrl("http://localhost:8001/")
                .contact(new Contact("Mr Liu", "http://localhost:8999/", "[e-mail]"))
                .license("what")
                .version("1.0")
                .build();
    }

}

apiInfo()設置后會改變如圖

三、bean實體類添加

/**
 * @author Administrator
 */
@ApiModel("用戶對象")
@Data
public class UserVO {

    @ApiModelProperty(required = true, notes = "用戶名", example = "blues")
    private String name;

    @ApiModelProperty(required = true, notes = "用戶返回消息", example = "hello world")
    private String words;


    public UserVO(String name, String words) {
        this.name = name;
        this.words = words;
    }
}

主要是添加注解

@ApiModel("用戶對象") -----實體類注解添加 添加后結果如圖所示:

@ApiModelProperty(required = true, notes = "用戶名", example = "blues") 字段注解添加 添加后結果如圖所示:

四、Controller添加

• 1、GET方式訪問
  

  package com.mrliu.undertow.controller;
  
  import com.mrliu.undertow.base.Results;
  import com.mrliu.undertow.pojo.UserVO;
  import io.swagger.annotations.*;
  import org.springframework.web.bind.annotation.GetMapping;
  import org.springframework.web.bind.annotation.PathVariable;
  import org.springframework.web.bind.annotation.RequestMapping;
  import org.springframework.web.bind.annotation.RestController;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import java.io.IOException;
  
  /**
   * @author Administrator
   */
  @Api(tags = "HELLO CONTROLLER 測試功能接口")
  @RestController
  public class HelloController {
  
  
      @ApiImplicitParams({
              @ApiImplicitParam(name = "name",value = "用戶名稱",required = true,dataType = "String",paramType = "path",example = "blues")
      })
      @ApiResponses(value = {
              @ApiResponse(code = 200, message = "接口返回成功狀態"),
              @ApiResponse(code = 500, message = "接口返回未知錯誤，請聯系開發人員調試")
      })
      @ApiOperation(value = "Hello 測試接口", notes = "訪問此接口，返回hello語句，測試接口")
      @GetMapping("hello/{name}")
      public Results<UserVO> hello(@PathVariable String name){
          UserVO userVO = new UserVO(name,"hello " + name);
          Results<UserVO> results = new Results<>(200,"SUCCESS", userVO);
          return results;
      }
  }

   界面生成:

• 2、POST方式訪問

@Api(tags = "HELLO CONTROLLER 測試功能接口")
@RestController
public class HelloController {


    @ApiImplicitParams({
            @ApiImplicitParam(name = "name",value = "用戶名稱",required = true,dataType = "String",paramType = "path",example = "blues")
    })
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "接口返回成功狀態"),
            @ApiResponse(code = 500, message = "接口返回未知錯誤，請聯系開發人員調試")
    })
    @ApiOperation(value = "Hello 測試接口", notes = "訪問此接口，返回hello語句，測試接口")
    @PostMapping("hello/{name}")
    public Results<UserVO> hello(@RequestBody UserVO userVO){
        Results<UserVO> results = new Results<>(200,"SUCCESS", userVO);
        return results;
    }
}

五、訪問URL

http://localhost:7788/doc.html

六、兼容swagger-ui訪問

http://localhost:7788/swagger-ui.html

七、測試

填入參數

對象請求訪問

八、API文檔復制

復制后可生成markdow文檔，使用showdoc，即可翻譯成文檔，下載html、PDF、word等格式


源碼地址:https://github.com/liushaoye/knife4j.git  歡迎點贊,分享,推薦