这篇文章主要介绍了Springboot如何集成knife4j实现风格化API文档，帮助大家更好的使用springboot框架，感兴趣的朋友可以了解下
POM引入插件
com.github.xiaoyminknife4j-spring-boot-starter<!--在引用时请在maven中央仓库搜索最新版本号 -->2.0.3
配置加载
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的资料请关注gaodaima搞代码网其它相关文章！
以上就是Springboot集成knife4j实现风格化API文档的详细内容，更多请关注gaodaima搞代码网来源gaodai#ma#com搞*!代#%^码$网其它相关文章！
搞代码网（gaodaima.com）提供的所有资源部分来自互联网，如果有侵犯您的版权或其他权益，请说明详细缘由并提供版权或权益证明然后发送到邮箱[email protected]，我们会在看到邮件的第一时间内为您处理，或直接联系QQ：872152909。本网站采用BY-NC-SA协议进行授权
转载请注明原文链接：Springboot集成knife4j实现风格化API文档
转载请注明原文链接：Springboot集成knife4j实现风格化API文档
