天天看點

Knife4j是swagger的增強方案

Knife4j是swagger的增強方案,可以比swagger更友好地顯示接口文檔。

接口界面如下:

UI通路位址:http://localhost:8088/doc.html

項目依賴

内部已內建 io.springfox

com.github.xiaoymin knife4j-spring-boot-starter 2.0.0

配置類

需要配置接口的附帶資訊,如作者等。

@Configuration //配置

@EnableSwagger2 //開啟Swagger2

@EnableKnife4j //開啟Knife4j

@Import(BeanValidatorPluginsConfiguration.class)

@ConditionalOnProperty(value = {“knife4j.enable”}, matchIfMissing = true)

public class Swagger2Config {

}

注意上方SwaggerUserApi和SwaggerSourceApi是我自定義注解,通過注解進行分組。如果不想使用,修改使用注解的方法即可

//資源api注釋

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

@Api(tags = “資源管理api”)

public @interface SwaggerSourceApi {

//使用者Api注釋

@Api(tags = “賬号管理Api”)

public @interface SwaggerUserApi {

至此knife4j已經配置完成了,需要在接口上添加swagger注解,就能顯示出資訊。用法和swagger一樣。

繼續閱讀