关于springboot集成swagger及knife4j的增强问题

参考链接：狂神的swagger笔记

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

springboot集成swagger 添加maven依赖

<dependency>
  <groupid>io.springfox</groupid>
  <artifactid>springfox-swagger2</artifactid>
  <version>2.9.2</version>
</dependency>

 <dependency>
  <groupid>io.springfox</groupid>
  <artifactid>springfox-swagger-ui</artifactid>
  <version>2.9.2</version>
 </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/", "2278023068@qq.com");
    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是为java mvc框架集成swagger生成api文档的增强解决方案（在非java项目中也提供了前端ui的增强解决方案），前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!

简洁

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

个性化配置

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

增强

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

springboot集成knife4j 添加maven依赖

<dependency>
      <groupid>com.github.xiaoymin</groupid>
      <artifactid>knife4j-spring-boot-starter</artifactid>
      <!--在引用时请在maven中央仓库搜索最新版本号-->
      <version>2.0.4</version>
 </dependency>

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

离线文档导出

knife4j提供导出4种格式的离线文档(html\markdown\word\pdf)

到此这篇关于springboot集成swagger以及knife4j的增强的文章就介绍到这了,更多相关springboot集成swagger内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com！