温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

SpringBoot使用knife4j实现在线调试接口的方法

发布时间:2020-11-04 17:02:17 来源:亿速云 阅读:610 作者:Leah 栏目:开发技术

这篇文章将为大家详细讲解有关SpringBoot使用knife4j实现在线调试接口的方法,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。

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实现在线调试接口的方法

关于SpringBoot使用knife4j实现在线调试接口的方法就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI