给Swagger换个新皮肤

蔚落 2023-03-01 09:05 112阅读 0赞

> ❝
> 
> knife4j是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，提供了简洁、强大的接口文档体验。
> 
> ❞

优点：

*  *简洁*：基于左右菜单式的布局方式,文档更清晰。
 *  *个性化配置*：支持接口地址、接口description属性、UI增强等个性化配置功能。
 *  *增强*：接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能。

官方文档地址：`https://doc.xiaominfo.com/`

在线演示地址：`http://swagger-bootstrap-ui.xiaominfo.com/doc.html`

## 快速开始 ##

接下来我们来介绍下如何在SpringBoot中使用knife4j，如果项目配置过swagger2，仅需两步即可！

如果没有，欢迎读者查阅之前发过的文章，[Swagger 介绍与使用][Swagger]

### 引入Maven依赖 ###

在`pom.xml`中增加knife4j的相关依赖：

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.6.1</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.6.1</version>
    </dependency>

### Swagger配置类增加注解 ###

在Swagger2Config中增加一个@EnableKnife4j注解，该注解可以开启knife4j的增强功能：

/**
     * ---------------------------
     * Swagger2配置类
     * ---------------------------
     * @author：XiaoYang
     * @date：2020-07-22
     * ---------------------------
     */
    @Configuration
    @EnableSwagger2
    @EnableKnife4j
    public class Swagger2Config {
    
    }

## 查看效果 ##

运行我们的SpringBoot应用，访问API文档地址即可查看：`http://localhost:8080/doc.html`

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70][]

可以下载离线文档，个性化设置等：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70 3][]

**一个从装环境开始的学习记录公众号，欢迎大家关注：**

![20200618140202867.jpg][]

[Swagger]: https://mp.weixin.qq.com/s/dnZf1EsOn9sIUQT6sr_efQ
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70]: /images/20230209/b3fd048c12d84b2e8406f975e2b12033.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70 1]: /images/20230209/7c507878b1e34773b5ea4558cf3159c2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200723104333865.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200723104347400.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3NTUyOTkz,size_16,color_FFFFFF,t_70
[20200618140202867.jpg]: https://img-blog.csdnimg.cn/20200618140202867.jpg