SpringBoot使用knife4j进行在线接口调试

 更新时间:2020年09月07日 15:24:14   作者:溪源的奇思妙想  
这篇文章主要介绍了SpringBoot使用knife4j进行在线接口调试,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

前言

我们在开发一个Java Web的项目,如果项目整体采用前后端分离的架构的方式,我们会经常使用Swagger来进行接口调试和为前端提供接口文档,但是Swagger并没有实际上那么方便,比如我们在发送Post请求时,参数选填还是非常不友好,那么有没有更好的工具呢?

正文

knife4j

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,具有小巧,轻量,并且功能强悍的优点。

Knife4j提供两大核心功能:文档说明 和 在线调试

文档说明:根据Swagger的规范说明,详细列出接口文档的说明,包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息,使用swagger-bootstrap-ui能根据该文档说明,对该接口的使用情况一目了然。

在线调试:提供在线接口联调的强大功能,自动解析当前接口参数,同时包含表单验证,调用参数可返回接口响应内容、headersCurl请求命令实例、响应时间、响应状态码等信息,帮助开发者在线调试,而不必通过其他测试工具测试接口是否正确,简洁、强大。

SpringBoot使用knife4j进行在线接口调试

注入依赖

<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>knife4j-spring-boot-starter</artifactId>
  <version>2.0.4</version>
</dependency>

SwaggerConfig.class :knife4j配置类

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {


  /**
   * 这里配置swagger扫描的包
   * @return
   */
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors
            .basePackage("com.luo.producer"))
        .paths(PathSelectors.any()).build();
  }


  /**
   * 这里配置swagger对外提供服务的端口
   * @return
   */
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder().title("发布模拟boos接口")
        .description("简单优雅的发布模拟boos接口restful风格接口")
        // .termsOfServiceUrl("http://127.0.0.1:8080/doc.html")
        .version("1.0").build();
  }
}

验证

测试接口

@RestController
@Slf4j
public class UserController {
  @GetMapping("/helloword")
  public String hello(String input){
    return "你好,"+input;
  }
 }

启动项目后:访问http://127.0.0.1:8080/doc.html

访问测试接口,进行测试:

到此这篇关于SpringBoot使用knife4j进行在线接口调试的文章就介绍到这了,更多相关SpringBoot knife4j在线接口调试内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java中-jar 与nohup的对比

    java中-jar 与nohup的对比

    这篇文章主要介绍了java中 -jar 与nohup的对比的相关资料,需要的朋友可以参考下
    2017-05-05
  • Java 通过反射变更String的值过程详解

    Java 通过反射变更String的值过程详解

    这篇文章主要介绍了Java 通过反射变更String的值过程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • Java8-Stream流操作List去重问题

    Java8-Stream流操作List去重问题

    这篇文章主要介绍了Java8-Stream流操作List去重问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • Redisson延迟队列执行流程源码解析

    Redisson延迟队列执行流程源码解析

    这篇文章主要为大家介绍了Redisson延迟队列执行流程源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09
  • Java实战练习之扑克牌魔术

    Java实战练习之扑克牌魔术

    这篇文章主要介绍了Java实战练习之扑克牌魔术,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
    2021-04-04
  • 详解Spring boot/Spring 统一错误处理方案的使用

    详解Spring boot/Spring 统一错误处理方案的使用

    这篇文章主要介绍了详解Spring boot/Spring 统一错误处理方案的使用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • Spring boot JPA实现分页和枚举转换代码示例

    Spring boot JPA实现分页和枚举转换代码示例

    这篇文章主要介绍了Spring boot JPA实现分页和枚举转换代码示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • 解决static类使用@Value获取yml文件获取不到的问题

    解决static类使用@Value获取yml文件获取不到的问题

    在静态类中直接使用@Value注解无法获取yml文件中的配置,解决方案是在工具类Utils中创建静态的setter方法,并从外部类ServiceClass中调用这个方法来设置值,这种方法通过外部调用来间接设置静态变量的值,从而成功读取yml配置
    2024-09-09
  • Spring容器初始化扩展点之ApplicationContextInitializer详解

    Spring容器初始化扩展点之ApplicationContextInitializer详解

    ApplicationContextInitializer是Spring框架提供的一个接口,用于在Spring应用上下文刷新之前对其进行自定义初始化,本文介绍Spring容器初始化扩展点之ApplicationContextInitializer,感兴趣的朋友一起看看吧
    2025-02-02
  • 将项目上传到Maven中央仓库(2023最新版)

    将项目上传到Maven中央仓库(2023最新版)

    本文主要介绍了将项目上传到Maven中央仓库(2023最新版),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-05-05

最新评论