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

 更新时间:2021年03月21日 08:51:10   作者:潇 七  
这篇文章主要介绍了springboot集成swagger以及knife4j的增强,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

参考链接:狂神的Swagger笔记

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

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的界面;
-

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.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <!--在引用时请在maven中央仓库搜索最新版本号-->
      <version>2.0.4</version>
 </dependency>

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

knife4j界面

离线文档导出

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

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

相关文章

  • java 汉诺塔详解及实现代码

    java 汉诺塔详解及实现代码

    这篇文章主要介绍了java 汉诺塔详解及实现代码的相关资料,需要的朋友可以参考下
    2017-04-04
  • Mybatis-plus支持Gbase8s分页的实现示例

    Mybatis-plus支持Gbase8s分页的实现示例

    本文主要介绍了Mybatis-plus支持Gbase8s分页的实现示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • JAVA中AES加密方法实例分析

    JAVA中AES加密方法实例分析

    这篇文章主要介绍了JAVA中AES加密方法,实例分析了java中AES加密与解密的实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • springboot实现添加邮件发送及压缩功能

    springboot实现添加邮件发送及压缩功能

    这篇文章主要介绍了springboot实现添加邮件发送及压缩功能 ,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-07-07
  • Java 并行数据处理和性能分析

    Java 并行数据处理和性能分析

    这篇文章主要介绍了Java 并行数据处理和性能分析,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • 关于Java从本地文件复制到网络文件上传

    关于Java从本地文件复制到网络文件上传

    这篇文章主要介绍了关于Java从本地文件复制到网络文件上传,File 和 IO 流其实是很相似的,都是将文件从一个地方转移到另一个地方,这也是流的特点之一,需要的朋友可以参考下
    2023-04-04
  • 关于SpringBoot自定义条件注解与自动配置

    关于SpringBoot自定义条件注解与自动配置

    这篇文章主要介绍了关于SpringBoot自定义条件注解与自动配置,Spring Boot的核心功能就是为整合第三方框架提供自动配置,而本文则带着大家实现了自己的自动配置和Starter,需要的朋友可以参考下
    2023-07-07
  • Intellij IDEA 添加jar包的三种方式(小结)

    Intellij IDEA 添加jar包的三种方式(小结)

    这篇文章主要介绍了Intellij IDEA 添加jar包的三种方式(小结),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08
  • Spring Boot在开发过程中常用IDEA插件

    Spring Boot在开发过程中常用IDEA插件

    这篇文章主要为大家介绍了Spring Boot在开发过程中常用IDEA插件,帮助大家提高开发工作效率,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-03-03
  • Java实战之校园外卖点餐系统的实现

    Java实战之校园外卖点餐系统的实现

    这篇文章主要介绍了如何利用Java实现简易的校园外卖点餐系统,文中采用的技术有:JSP、Spring、SpringMVC、MyBatis 等,感兴趣的可以了解一下
    2022-03-03

最新评论