spring整合knif4j启动

原创

已于 2023-12-02 09:15:40 修改 · 374 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#spring #java #后端

于 2023-11-27 20:05:49 首次发布

本文介绍了如何在SpringBoot项目中配置Swagger2WebMvc和Knife4j，包括创建配置类、添加相关依赖、处理MVC版本问题以及配置文档控制器。读者可以了解到如何设置API信息、分组和指定扫描路径，以实现RESTfulAPI的文档生成。

1.1配置类

先导一个配置类，配置类的配置如下

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("测试==demo")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact(new Contact("玉面小白龙", "", "123@qq.com"))
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定文档Controller层扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.**.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;

    }
}

1.2依赖导入

配置文件好了后，我们导入3个依赖<

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

code3306

关注关注

3
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

Spring Boot集成Knife4j增强API文档功能：从入门到精通（保姆级教程）

本博客聚焦 YOLOv11 全流程落地，涵盖架构优化、数据集处理、训练技巧与多场景部署，兼及国产数据库、Java 开发与 AI 模型应用，内容兼顾理论与工程实践，为开发者提供系统干货，助力高效提升技术能力。

05-31

1778

Knife4j是基于Swagger的API文档增强工具，为Java开发者提供了一套更强大、更美观的API文档解决方案。它就像是API文档界的"瑞士军刀"，不仅保留了Swagger的所有功能，还增加了许多实用特性。

在Spring MVC环境中集成Knie4j

八一菜刀的专栏

09-14

3251

如果你是Spring MVC项目,想使用knife4j提供的增强ui包,使用方法很简单 demo参考示例地址：knife4j-spring-mvc-demo 依赖引用 2.0.4(包含)以前的版本如果开发者使用的是2.0.4(包含)以前的版本,那么需要引入以下2个jar包第一步是需要引入Knife4j提供的依赖包，如下：  <dependency> <groupId>com.github.xiaoymin</groupId

参与评论您还未登录，请先登录后发表或查看评论

JAVA SpringMVC老项目集成knife4j

大圈技术博客

11-18

1867

后端Java代码和ui包分离为多个模块的jar包,以面对在目前微服务架构下,更加方便的使用增强文档注解(使用SpringCloud微服务项目,只需要在网关层集成UI的jar包即可,因此分离前后端)一开始项目初衷是为了写一个增强版本的swagger的前端ui,但是随着项目的发展,面对越来越多的个性化需求,不得不编写后端Java代码以满足新的需求,在。剩下的工作即将旧有的showdoc中的文档一一对应的在系统中编写对应的接口进行迁移测试即可，当迁移测试完善完成后，即可舍弃旧有的文档工具。

1.2 SpringMVC框架集成Knife4j（官网）（内含源代码）

weixin_46411355的博客

02-21

1053

1.2 SpringMVC框架集成Knife4j（官网）（内含源代码） 1.2.1 依赖引用 1.2.1.1 2.0.4(包含)以前的版本 1.2.1.2 2.0.4(不包含)以后的版本 1.2.2 创建配置文件 1.2.3 配置静态文件 1.2.4 配置增强Filter(可选) 1.2.5 配置web.xml 1.2.6 配置增强模式(可选) 1.2.6.1 2.0.4(包含)以前的版本 1.2.6.2 2.0.4(不包含)以后的版本 1.2.7 访问

SpringMVC工作流程概述

微笑的丁总的个人博客

10-19

756

与Struts2原理不同，SpringMVC是通过最基础最传统的servlet来实现对框架源代码的封装以及对整个流程的控制的，而Struts2是通过过滤器来实现URL路径与具体Action的对应关系确认的。 1、客户端向web服务器(如tomcat)发送一个http请求，web服务器对http请求进行解析，解析后的URL地址如果匹配了DispatcherServlet的映射路径(通过we...

Knife4j使用教程

jakelihua

08-28

2614

查看和测试接口：在Knife4j的文档页面上，你可以查看和测试你的API接口。可以通过分类、搜索等方式快速定位到需要的接口，点击接口可以查看详细的接口信息和示例。集成Swagger：Knife4j基于Swagger，可以直接解析Swagger注解生成API文档，无需额外的配置和编写文档。配置Swagger注解：在你的API接口类和方法上添加Swagger注解，用于描述接口的信息、参数、返回值等。引入依赖：在你的项目中添加Knife4j的相关依赖，具体的依赖配置可以参考Knife4j的官方文档。

springcloud整合Knife4j

0~N

07-22

2163

写这篇文章的由头是手头有个springcloud项目是上一个同学用swagger配置的，他配置写的有点混乱，每个服务都配了一遍swagger的依赖，这让强迫症的我极度不适，而且我个人比较习惯用Knife4j文档，之前一直是用springboot，所以不太清楚springcloud整合Knife4j有哪些注意点，百度了一下好像都和我后面实现的方案不一样，那咱就隔这浅浅记录一下。2、在公共模块的pom.xml也引入Knife4j相关配置。4、做好以上配置，直接启动你本地的项目。3、在公共模块写一个配置类。...

心链3---（整合Knif4j接口文档 + 爬虫信息导入数据库）

Rockivy的博客

05-27

706

可以通过在 controller 方法上添加 @Api、@ApiImplicitParam(name = “name”,value = “姓名”,required = true) @ApiOperation(value = “向客人问好”) 等注解来自定义生成的接口描述信息。🎈鱼皮这里因为springboot版本和swagger版本的问题，并没有去具体实现swagger接口实现的效。(如果容易犯迷糊的，可以直接看下面knife4j，是按鱼皮的直播来的。（上面提到的yml配置，最开始的那个代码块。

深入浅出Spring Cloud整合knife4j

CERTAINTY的博客

12-27

4620

深入浅出Spring Cloud整合knife4j

Knife4j-的使用(详细教程)

最新发布

三木的博客

06-24

1541

这是配置类的信息,里面有一个非常符合java设计模式和拓展性的是引入了SwageerConfigProperties依赖,在这个依赖中调整我们可能会发生变化的值,提高了代码的拓展性。是 Java 中的一个标记接口（marker interface），位于。它没有任何方法，只是作为一个标记，表明实现它的类可以被序列化。：Spring Boot 会自动将配置属性绑定到类的字段。Starter 的自动配置类通常带有类似条件注解。注册为 Spring 容器中的 Bean。该注解会导入 Knife4j 的核心配置。

终于放弃了单调的 Swagger 了，选择了这款神器 Knife4j

芋艿V

02-24

896

点击上方“芋道源码”，选择“设为星标”做积极的人，而不是积极废人！源码精品专栏原创 | Java 2019 超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络...

knife4j：快速入门

人类所有真实的快乐，一定是恒久的努力

11-15

9750

大纲一、依赖二、配置类三、控制层编写四、页面显示五、Swagger常用注解六、访问权限控制6.1 方法一：@Value6.2 方法二：@Profile6.3 方法三：使用knife4j的增强功能6.4 方法四：输入用户名以及密码技术版本 springboot：2.5.6 Knife4j ：2.0.9 一、依赖在本次项目中，pom.xml使用的依赖如下所示： <properties> <java.version>1.8</java.version&gt

Springboot整合knife4j与shiro

wind1_rain的博客

09-14

3236

一、介绍knife4j 增强版本的Swagger 前端UI,取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍,更名也是希望把她做成一个为Swagger接口文档服务的通用性解决方案,不仅仅只是专注于前端Ui前端。二、Spring Boot 整合knife4j 第一步，在Maven中的pom.xml文件引入: <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId

knife4j介绍及使用

weixin_55076626的博客

09-30

2万+

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名knife4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!其底层是对Springfox的封装，使用方式也和Springfox一致，只是对接口文档UI进行了优化。

spingboot整合knif4j

05-20

Spring Boot整合Knife4j可以快速生成API接口文档，可以让前后端更好的协作，提高开发效率。下面是整合步骤： 1. 引入依赖在pom.xml文件中添加Knife4j的依赖： ``` <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.2</version> </dependency> ``` 2. 配置Swagger 在Spring Boot启动类上添加@EnableSwagger2注解开启Swagger，示例代码如下： ``` @SpringBootApplication @EnableSwagger2 public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } } ``` 3. 配置Knife4j 在application.properties文件中配置Knife4j的相关属性，示例代码如下： ``` # 设置Knife4j文档页面的标题 spring.application.name=Demo # 配置Knife4j的访问路径 springfox.documentation.swagger.v2.path=/api-docs # 配置Knife4j的UI页面访问路径 knife4j.swagger-ui.path=/doc.html ``` 4. 编写API文档在Controller类上使用Swagger注解编写API文档，示例代码如下： ``` @RestController @RequestMapping("/user") @Api(tags = "用户管理") public class UserController { @ApiOperation(value = "获取用户列表", notes = "获取所有用户列表") @GetMapping("/") public List<User> list() { // ... } @ApiOperation(value = "创建用户", notes = "根据User对象创建用户") @PostMapping("/") public String create(@RequestBody User user) { // ... } @ApiOperation(value = "更新用户", notes = "根据User对象更新用户") @PutMapping("/") public String update(@RequestBody User user) { // ... } @ApiOperation(value = "删除用户", notes = "根据用户ID删除用户") @DeleteMapping("/{id}") public String delete(@PathVariable Long id) { // ... } } ``` 5. 查看API文档启动Spring Boot应用程序后，访问http://localhost:8080/doc.html即可查看API文档页面。以上就是Spring Boot整合Knife4j的步骤，希望对你有所帮助。