springboot集成swagger以及knife4j的增强

springboot集成swagger以及knife4j的增强

参考链接：狂神的Swagger笔记

swagger

• 号称世界上最流行的API框架
• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
• 直接运行，在线测试API
• 支持多种语言 （如：Java，PHP等）
• 官网：swagger

SpringBoot集成Swagger 添加maven依赖

<dependency>
   <groupId>io.springfoxgroupId>
   <artifactId>springfox-swagger2artifactId>
   <version>2.9.2version>
dependency>

 <dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>2.9.2version>
  dependency>

• 要求：jdk 1.8 + 否则swagger2无法运行

要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

package com.yf.exam.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

import java.util.ArrayList;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    //配置了swagger的Docket 的 bean 实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }
    //配置 swagger 信息 = apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("潇七", "https://www.xhost.vip/", "[email protected]");
        return new ApiInfo("API文档",
                "接口信息",
                "v1.0",
               
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}

• 访问测试 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；
  -

knife4j

• 官网参考地址：knife4j
  knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案（在非Java项目中也提供了前端UI的增强解决方案），前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!

• 简洁

  基于左右菜单式的布局方式,是更符合国人的操作习惯吧.文档更清晰…

• 个性化配置

  个性化配置项,支持接口地址、接口description属性、UI增强等个性化配置功能…

• 增强

  接口排序、Swagger资源保护、导出Markdown、参数缓存众多强大功能.

SpringBoot集成Knife4j 添加maven依赖

<dependency>
            <groupId>com.github.xiaoymingroupId>
            <artifactId>knife4j-spring-boot-starterartifactId>
            
            <version>2.0.4version>
 dependency>

• -访问测试 ：http://localhost:8080/doc.html ，可以看到knife4j的界面；
  

• 离线文档导出

Knife4j提供导出4种格式的离线文档(Html\Markdown\Word\Pdf)

致谢

感谢您阅读我的文章，如果我的文章对您有所帮助，请分享出去让更多的小伙伴知道；如果我的文章有误导或是存在错误，请指点更正，大家一起共同进步。谢谢！