Java基礎之SpringBoot整合knife4j

插件的特點(diǎn)

1、非常簡(jiǎn)潔清爽的UI設計，接口的快速搜索。

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

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

3、全局參數設置，可以很方便的設置Token等權限認證參數。

4、離線(xiàn)API文檔下載：

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

5、對 json 格式的數據有更好的支持，可以折疊展開(kāi)等。

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

導入pom依賴(lài)

<!--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í)請在maven中央倉庫搜索最新版本號-->
    <version>2.0.2</version>
</dependency>

/**
 * 訪(fǎng)問(wèn)地址 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界面的統一管理接口。都必須在此包下
                    //.apis(RequestHandlerSelectors.basePackage("com.baozun.dma.collection.delivery.controller"))
                    //方式二: 只有當方法上有  @ApiOperation 注解時(shí)才能生成對應的接口文檔
               .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();
        }

}

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

    @Autowired
    private MappingRelationManager mappingRelationManager;



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

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


}

訪(fǎng)問(wèn)路徑：http://127.0.0.1:2888/doc.html

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