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

前言

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

正文

knife4j

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

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

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

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

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在线接口调试内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！