首页 > 其他分享 >Springboot3集成knife4j,swagger实现在线接口文档

Springboot3集成knife4j,swagger实现在线接口文档

时间:2024-07-30 22:56:48浏览次数:16  
标签:knife4j springframework API Springboot3 org import swagger

什么是knife4j

knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案,帮助开发者快速聚合使用OpenAPI规范,快速生成API文档,并且提供一些额外的功能,比如:

  1. API文档生成:可以根据Controller和方法上的注解自动生成Markdown格式的API文档
  2. 在线访问API:可以在knife4j的页面直接访问我们的API接口
  3. Token管理:可以在knife4j中对API Token进行管理
  4. 比较请求与响应:可以比较同一个API的请求与响应内容的差异
  5. 高亮API响应:将API响应中的JSON高亮显示,方便查看
  6. ......具体信息请看官网文档

knife4j官网:https://doc.xiaominfo.com/

我以之前那篇集成邮箱的笔记为基础集成 knife4j,有不懂邮箱验证的可以去看我的笔记

Springboot集成邮箱发送验证码-CSDN博客

1 引入依赖

这里我直接把我项目的所有依赖放出来了

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- 邮箱验证码依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
        <!-- 一个很强大的工具库 -->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.8.19</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--swagger测试-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
            <version>4.1.0</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

    </dependencies>

2 yaml文件配置

# springdoc-openapi项目配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.example.email.controller #这里要选择你的接口对应的包名
# knife4j的增强配置,不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

 3 knife4j 配置类

package com.example.email.config;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {
    
    @Bean
    public OpenAPI springShopOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("邮箱验证码接口文档")
                        .description("邮箱验证码接口文档")
                        .version("v1")
                        .license(new License().name("Apache 2.0").url("http://springdoc.org")))
                .externalDocs(new ExternalDocumentation()
                        .description("外部文档")
                        .url("https://springshop.wiki.github.org/docs"));
    }
    
}

4 编写测试接口

首先项目的目录结构是这样的

 测试接口代码如下:

package com.example.email.controller;

import cn.hutool.core.util.RandomUtil;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/send")
@RequiredArgsConstructor //Lombook提供的构造,使用构造器注入bean
@Tag(name = "邮箱管理")
public class SendController {
    
    // 这个是 mail 依赖提供给我们的发送邮件的接口
    private final JavaMailSender mailSender;
    
    // yaml配置中获取发件人邮箱
    @Value("${spring.mail.username}")
    private String sender;
    
    // yaml配置中获取发件人昵称
    @Value("${spring.mail.nickname}")
    private String nickname;
    
    @GetMapping
    @Operation(summary = "发送")
    public String sendEmail(@Parameter(name = "email", description = "邮箱账号")String email){
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom(nickname + '<' + sender + '>');
        message.setTo(email);
        message.setSubject("邮箱登录验证码");
        // 使用 hutool-all 生成 6 位随机数验证码
        String code = RandomUtil.randomNumbers(6);
        String content = "【验证码】您的验证码为:" + code + " 。 验证码五分钟内有效,逾期作废。";
        message.setText(content);
        mailSender.send(message);
        return "发送成功";
    }


}

5 运行项目

访问地址:http://localhost:8080/doc.html

效果如下:

点击 接口进行测试就OK啦

 

发送,发送验证码成功! 

标签:knife4j,springframework,API,Springboot3,org,import,swagger
From: https://blog.csdn.net/weixin_63491903/article/details/140808639

相关文章

  • EasyExcel数据导出实现、动态表头生成、SpringBoot3框架
    1、引入EasyExcel依赖<dependency><groupId>com.alibaba</groupId><artifactId>easyexcel</artifactId><version>3.3.2</version></dependency>2、定义ExcelModel表单模型publicclassExcelMod......
  • Swagger、Docker、Python-Flask: : https://editor.swagger.io/ 生成服务器 python-fl
    在https://editor.swagger.io/上您可以粘贴一些json/yaml。我正在将此作为JSON进行测试(不要转换为YAML):{"swagger":"2.0","info":{"version":"1.0","title":"OurfirstgeneratedRES......
  • 3、springboot3 vue3开发平台-后端-swagger,knife4j整合
    文章目录1.knife4j简介2.引入依赖3.简单配置4.测试1.knife4j简介Knife4j是一个集Swagger2和OpenAPI3为一体的增强解决方案帮助开发者快速聚合使用OpenAPI规范。兼容OpenAPI3,使用更简介界面较swagger好看,文档导出、测试功能更简介方便官网:https://doc.......
  • 搭建.Net WebApi并配置Swagger(一)
    C#进阶之WebAPI(一)那么首先第一点:什么是WebAPI?首先我们了解一下.netframework的框架构成:   可以看到,WebAPI和mvc同属于B/S模板框架的一种,官方对于WebApi的定义是:WebAPI是一个框架,可以轻松构建HTTP服务,覆盖广泛的客户端,包括浏览器和移动设备,WebAPI是在.NetFramwo......
  • SpringBoot3.x整合Druid数据库连接池
    引入依赖<!--Druid数据库连接池--><dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-3-starter</artifactId><version>1.2.21</version></dependency......
  • SpringBoot整合Swagger2,代码文档一手抓
    文章目录引言什么是swaggerSwagger的优势SpringBoot整合Swagger2添加Swagger依赖application.yml配置配置类SwaggerConfig启动类配置RESTful实战案例参考常见swagger注解说明页面访问效果常见错误引言什么是swaggerSwagger是一个规范且完整的框架,用于生成、描......
  • c#配置swagger文档
    .netcore6.0注入swagger,.netcore配置swagger文档6.1号更新token验证 builder.Services.AddSwaggerGen(c=>{//添加token验证c.AddSecurityDefinition("Bearer",newOpenApiSecurityScheme{Description="请输入token,格式为Bearerxxxxxxxx",......
  • Swagger文档折叠了字段描述,很苦恼!
    引言在SwaggerUI3.0及之后的版本,文档中的模型显示上,一些简单数据类型的字段描述都被折叠掉了,一眼望去全都是中括号。相比于2.0版本非常不直观。正文看了一些解决方案,一些大佬直接嵌入js把折叠展开了,非常的有效果,但少了点优雅。翻了一些资料发现中间件本身带有一些设置项......
  • c# swagger api分组
    ConfigureServices修改services.AddSwaggerGen(c=>{c.SwaggerDoc("v1",newOpenApiInfo{Title="SwaggerTest",Version="v1"});c.SwaggerDoc("User",newOpenApiInfo{Title="U......
  • java项目(knife4j使用,静态资源未放在static资源包下,公共字段自动填充,Spring Cache与Spr
    Knife4j(生成接口文档)使用swagger你只需要按照它的规范去定义接口及接口相关的信息,就可以做到生成接口文档,以及在线接口调试页面。官网:https://swagger.io/Knife4j是为JavaMVC框架集成Swagger生成Api文档的增强解决方案。使用方式1、导入knife4j的maven坐标<dependency>......