Python入门到实战 Redis express flask checkbox pdo parameters x86 rss vue绑定事件 vue引入组件 外卖系统源码 jquery循环 mysql数据库名称 bootstrap日历控件 pip环境变量配置 android网络请求 python语言入门 python教程 python中set的用法 python读取mysql数据 python模块下载 java教程 java数组扩容 java终止线程 java获取当前线程 java接口调用 liunx命令大全 linux中grep 图吧导航怎么样 计算机操作系统第四版 凤凰刷机 疯狂java讲义 流程图工具 pmbok第六版 js发送http请求 茸好珠 重复文件查找软件 超过响应缓冲区限制 超级网游助手
当前位置: 首页 > 学习教程  > 编程语言

接口自动生成工具---knife4j

2021/1/22 23:09:19 文章标签:

接口自动生成工具—knife4j 之前写过关于swagger的接口自动生成的小工具的使用说明文档&#xff0c;后来又发现和学习了一 个可以实现下载和页面更加优雅的工具—knife4j。下面一起来看看吧 1、导入相关的依赖 <dependency><groupId>com.github.xiaoymin</gro…

接口自动生成工具—knife4j

之前写过关于swagger的接口自动生成的小工具的使用说明文档,后来又发现和学习了一 个可以实现下载和页面更加优雅的工具—knife4j。下面一起来看看吧
1、导入相关的依赖

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

2、在模块中添加一个关于knife4j的配置类

package com.cast.common.knife4j;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

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

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("1.0")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.cast"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXAPI文档")
                .description("XXXAPI文档")
                .version("1.0")
                .build();
    }
}

注解说明
@EnableSwagger2:该注解是Springfox-swagger框架提供的使用Swagger注解,该注解必须加。
@EnableKnife4j:该注解是knife4j提供的增强注解,Ui提供了例如动态参数、参数过滤、接口排序等增强功能,如果你想使用这些增强功能就必须加该注解,否则可以不用加

3、在config包下新建类KnifeConfig,用来开启knife4j

@Configuration
@ComponentScan("com.cast.common.knife4j")
public class KnifeConfig {
}

4、访问:http://域名:端口号/doc.html
在这里插入图片描述

二、关于knife4j的使用说明
1、接口数据的文档展示在这里插入图片描述
2、接口调试
在这里插入图片描述
3、接口文档的保存
在这里插入图片描述
以上就是关于knife4j的搭建和学习,希望可以帮助到大家!


本文链接: http://www.dtmao.cc/news_show_630875.shtml

附件下载

相关教程

    暂无相关的数据...

共有条评论 网友评论

验证码: 看不清楚?