如何在Springboot中利用knife4j对API文档进行风格化

  介绍

本篇文章给大家分享的是有关如何在Springboot中利用knife4j对API文档进行风格化,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。

POM引入插件

& lt; dependency>   & lt; groupId> com.github.xiaoymin   & lt; artifactId> knife4j-spring-boot-starter   & lt; !——在引用时请在maven中央仓库搜索最新版本号,——比;   & lt; version> 2.0.3   & lt;/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 摘要(DocumentationType.SWAGGER_2) .apiInfo (apiInfo ())   .select ()//,这里指定控制器扫描包路径   .apis (RequestHandlerSelectors.basePackage (   ,,,,,,,,,,,,,,,,,“com.pengsn.apiserver.videoconference.business"))   .paths (PathSelectors.any ()) .build ();   return 摘要;   }   ,   private  ApiInfo  apiInfo (), {   Contact  Contact =, new 联系(“pengsn",,,,,,,,);   return  new  ApiInfoBuilder () .title(“视频会议接口描述“)。   描述(“视频会议接口描述“).contact(接触).version (“1.0“) .build ();   }   }

注解使用

<李>

@Api(标签=翱刂破鱠escription");作用于类

<李>

@ApiOperator (value=https://www.yisu.com/zixun/苯涌诿啤?指出=敖涌诿枋觥?作用于方法

<李>

@ApiOperationSupport(订单=1)排序

界面显示

如何在Springboot中利用knife4j对API文档进行风格化

以上就是如何在Springboot中利用knife4j对API文档进行风格化,小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注行业资讯频道。

如何在Springboot中利用knife4j对API文档进行风格化