Springboot集成knife4j實現風格化API文檔
POM引入插件
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <!--在引用時請在maven中央倉庫搜索最新版本號 --> <version>2.0.3</version> </dependency>
配置加載
package com.pengsn.apiserver.videoconference.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j; import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration; 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; /** * 配置 */ @Configuration @EnableSwagger2 @EnableKnife4j @Import(BeanValidatorPluginsConfiguration.class) public class SwaggerConfiguration { @Bean(value = "defaultApi2") public Docket defaultApi2() { Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) .select() // 這裡指定Controller掃描包路徑 .apis(RequestHandlerSelectors.basePackage( "com.pengsn.apiserver.videoconference.business")) .paths(PathSelectors.any()).build(); return docket; } private ApiInfo apiInfo() { Contact contact = new Contact("pengsn", "", ""); return new ApiInfoBuilder().title("視頻會議接口描述"). description("視頻會議接口描述").contact(contact).version("1.0").build(); } }
註解使用
- @Api(tags=”controller description”); 作用於 類
- @ApiOperator(value=”接口名稱”, notes=”接口描述”) 作用於 方法
- @ApiOperationSupport(order=1) 排序
界面顯示
以上就是Springboot集成knife4j實現風格化API文檔的詳細內容,更多關於Springboot集成knife4j的資料請關註WalkonNet其它相關文章!
推薦閱讀:
- 關於springboot集成swagger及knife4j的增強問題
- SpringBoot集成Swagger3的實現
- springboot更新配置Swagger3的一些小技巧
- 手把手教你SpringBoot快速集成Swagger的配置過程
- Spring Boot 集成 Swagger2構建 API文檔