快捷導(dǎo)航

Java基礎(chǔ)之SpringBoot整合knife4j

更新時(shí)間：2021年05月13日 16:58:02 作者：不想做咸魚的王富貴

Swagger現(xiàn)在已經(jīng)成了最流行的接口文檔生成與管理工具,但是你是否在用的時(shí)候也在吐槽,它是真的不好看,接口測試的json數(shù)據(jù)沒法格式化,測試地址如果更改了還要去改配置,接口測試時(shí)增加token驗(yàn)證是真的麻煩…針對(duì)Swagger的種種缺點(diǎn),Knife4j就呼之欲出了.需要的朋友可以參考下

插件的特點(diǎn)

1、非常簡潔清爽的UI設(shè)計(jì)，接口的快速搜索。

2、支持個(gè)性化設(shè)置，個(gè)性化設(shè)置包含：

 請(qǐng)求參數(shù)緩存
	  動(dòng)態(tài)請(qǐng)求參數(shù)
	  RequestMapping接口過濾
	  HOST代理設(shè)置

3、全局參數(shù)設(shè)置，可以很方便的設(shè)置Token等權(quán)限認(rèn)證參數(shù)。

4、離線API文檔下載：

Markdown（已支持）
  Html（已支持）
  Word（已支持）
  OpenApi（已支持）

5、對(duì) json 格式的數(shù)據(jù)有更好的支持，可以折疊展開等。

在這里插入圖片描述

knife4j官方文檔地址： https://doc.xiaominfo.com/knife4j/

導(dǎo)入pom依賴

<!--lombok插件-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用時(shí)請(qǐng)?jiān)趍aven中央倉庫搜索最新版本號(hào)-->
    <version>2.0.2</version>
</dependency>

/**
 * 訪問地址 http://127.0.0.1:2888/doc.html
 */
@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {


        @Bean
        public Docket createRestApi() {
            return  new Docket(DocumentationType.SWAGGER_2)
                    .useDefaultResponseMessages(false)
                    .apiInfo(apiInfo())
                    .select()
                    //方式一: 配置掃描 所有想在swagger界面的統(tǒng)一管理接口。都必須在此包下
                    //.apis(RequestHandlerSelectors.basePackage("com.baozun.dma.collection.delivery.controller"))
                    //方式二: 只有當(dāng)方法上有  @ApiOperation 注解時(shí)才能生成對(duì)應(yīng)的接口文檔
               .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                    .paths(PathSelectors.any())
                    .build();

        }

        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("Knife4j APIs")
                    .description("swagger-bootstrap-ui")
                    .termsOfServiceUrl("http://localhost:2888/")
                    .version("1.0")
                    .build();
        }

}

/**
 *  數(shù)據(jù)關(guān)系投遞Controller
 * @author: wys
 * @create: 2021-05-08 14:20
 **/
@Api(value = "數(shù)據(jù)關(guān)系投遞接口", tags = "數(shù)據(jù)關(guān)系投遞接口")
@RestController("/MappingRelation")
public class MappingRelationController {

    @Autowired
    private MappingRelationManager mappingRelationManager;



    @GetMapping("/findList")
    @ApiOperation(value = "查看數(shù)據(jù)關(guān)系", tags = "數(shù)據(jù)關(guān)系投遞接口")
    public List<MappingRelationManager> findList(){

        List<MappingRelationManager> list = mappingRelationManager.ListMappingRelation();
        return list;
    }


}

訪問路徑：http://127.0.0.1:2888/doc.html

到此這篇關(guān)于Java基礎(chǔ)之SpringBoot整合knife4j的文章就介紹到這了,更多相關(guān)SpringBoot整合knife4j內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: