Springboot整合knife4j生成文档

前言

在开发过程中,接口文档是很重要的内容,用于前端对接口的联调,也用于给其他方使用。但是手写相对比较麻烦。

当然也有swagger之类的,但是界面没有那么友好。

官网:

整合步骤

整合依赖

需要根据版本进行,具体可以参考文档

我这里是springboot 2.6.7的,因此使用 OpenAPI2即可

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

配置yaml文件

knife4j:enable: true
#  基础权限访问配置basic:enable: true# Basic认证用户名username: test# Basic认证密码password: 123openapi:
#    配置基础信息title: Knife4j官方文档description: "`我是测试`,**你知道吗**# aaa"email: xiaoymin@foxmail.comconcat: 八一菜刀url: https://docs.xiaominfo.comversion: v4.0license: Apache 2.0license-url: https://stackoverflow.com/terms-of-service-url: https://stackoverflow.com/
#    分组配置, 可用于扫描不同的包group:test1:group-name: 测试分组1api-rule: packageapi-rule-resources:- com.walker.knife4j.controller

具体的配置,可以查看配置类和文档

/** Copyright 2017-2022 八一菜刀(xiaoymin@foxmail.com)** Licensed under the Apache License, Version 2.0 (the "License");* you may not use this file except in compliance with the License.* You may obtain a copy of the License at**     http://www.apache.org/licenses/LICENSE-2.0** Unless required by applicable law or agreed to in writing, software* distributed under the License is distributed on an "AS IS" BASIS,* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.* See the License for the specific language governing permissions and* limitations under the License.*/package com.github.xiaoymin.knife4j.spring.configuration;import com.github.xiaoymin.knife4j.core.model.MarkdownProperty;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;import java.util.List;/**** Knife4j Basic Properties* @since  1.9.6* @author <a href="mailto:xiaoymin@foxmail.com">xiaoymin@foxmail.com</a> * 2019/08/27 15:40*/
@Component
@Data
@ConfigurationProperties(prefix = "knife4j")
public class Knife4jProperties {/*** Whether to enable knife4j enhanced mode*/private boolean enable = false;/*** Basic Document OpenAPI information*/private Knife4jInfoProperties openapi;/*** Enable default cross domain,default is false.*/private boolean cors = false;/*** Enable HTTP Basic authentication,default is false.*/private Knife4jHttpBasic basic;/*** Is it in the production environment? If yes, all documents cannot be accessed at present,default is false*/private boolean production = false;/*** The Personalized configuration*/private Knife4jSetting setting;/*** The group of Custom Markdown resources*/private List<MarkdownProperty> documents;
}

编写测试接口


package com.walker.knife4j.controller;import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;// 1、使用@Api注解,代表目录
@Api(value = "测试控制器", tags = "测试API")
@RestController
public class TestController {// 2、具体接口@ApiOperation("打招呼")@GetMapping("/hello")public String hello() {return "Hello ";}}

其他相关注解可参考:

主要引用的是swagger的,knife4j是在swagger的基础上进行封装

启动项目、访问

注意:需要放开doc.html的白名单访问

访问路径:ip:port/doc.thml

访问后需要输入basic设置的账号密码

就可以看到我们的测试的类和方法了

可以根据注解进行请求参数、返回结果类的配置等

也可以直接使用调试功能对代码进行调试,具体便不再演示,可自行操作。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/57124.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java方法的递归调用

Java中的方法可以通过调用自身来实现递归调用。 递归调用在解决一些问题时非常有用&#xff0c;特别是那些可以分解为相同结构的子问题的情况。递归调用可以让问题的解决过程更加简洁和优雅。 下面是一个简单的示例&#xff0c;展示了如何使用递归调用来计算一个数字的阶乘&a…

如何使用 pnpm 进行打补丁patch操作?推荐两个方法

前言 作为一个前端开发者&#xff0c;我们每天都在和各种各样的库和依赖打交道。node_modules 目录中存放着我们项目的各种依赖。我们有时需要对其中的一些依赖进行修改&#xff0c;比如修复某个 bug 或者增加某些自定义功能。这时候&#xff0c;给 node_modules 打补丁就显得…

软考高级系统架构设计师 知识产权

是记录&#xff0c;这一章内容是选择题&#xff0c;分值是两到三分之间 计算机保护条例 软件地定义 软件是软件及其文档 软件开发者 即写代码或者组织开发地&#xff0c;并对开发完成地软件承担责任地法人软件著作权人&#xff0c;是对软件享有著作权地自然人、法人或者其他组…

springboot 对接Telegram发送消息

官方maven包项目 https://repo.maven.apache.org/maven2/org/telegram/ 官方github仓库 https://github.com/rubenlagus 发送消息demo代码 PostMapping("/test")public void test(RequestParam("chatId") String chatId,RequestParam("messageTe…

准备用esp32-c3搞一个无线开关

思路&#xff1a; 用两片c3,一片作为开关&#xff0c;另一片作为http servet控制灯泡&#xff0c;两者采用wifi 连接 开关&#xff1a;GPIO 2脚电阻上拉&#xff0c;平时始终为高电平&#xff0c;开灯时按下按钮&#xff0c;2脚接地&#xff0c;电平为低电平。再用wifi把此信…

为您的 WordPress 网站打造完美广告布局 A5广告单元格插件

一个为 WordPress 网站量身定制的强大工具,它将彻底改变您展示广告的方式 灵活多变的布局设计 A5 广告单元格插件的核心优势在于其无与伦比的灵活性。无论您是想要创建整齐的网格布局,还是希望打造独特的不规则设计,这款插件都能满足您的需求。 自定义网格数量&#xff1a;从 2…

中小型企业网络的设计与实现

资料下载中小型企业网络的设计与实现论文资源-CSDN文库 摘 要 本文规划的是一个公司的网络搭建&#xff0c;网络设计包括了多个部门的网络架构&#xff0c;每个部门通过VLAN进行隔离&#xff0c;确保了网络的安全性和高效。 华为企业网络模拟平台&#xff08;ENSP&#xff09…

androidStudio编译导致的同名.so文件冲突问题解决

files found with path lib/arm64-v8a/libserial_port.so from inputs: ...\build\intermediates\library_jni\debug\jni\arm64-v8a\libserial_port.so C:\Users\...\.gradle\caches\transforms-3\...\jni\arm64-v8a\XXX.so 解决方式如下&#xff1a; 1.将gradle缓存文件删…

TwinCAT3安装 Advanced Motion Pack库

文章目录 一.简介二.安装方式1. 下载地址2. 双击下载好的安装包3. 选择语言&#xff08;只有英文和德语&#xff09;4. 点击Next5. 选择Accept6. 填写公司和组织名称&#xff08;随意&#xff09;7. 点击Install8. 等待安装完成9. 点击Finish 一.简介 TF5420 TC3 Motion Pick-…

深度学习-1:逻辑回归和梯度下降

逻辑回归 逻辑回归是一个二分分类问题 比如判断一张图片中是否是猫就是一个二类分类问题 图像由像素值组成&#xff0c;要将图像输入模型&#xff0c;就将其变为一个向量&#xff0c;该向量存储三个通道上的所有像素值&#xff0c;若图像尺寸为64x64x3&#xff0c;则向量维度…

RequestBody接收参数报错com.fasterxml.jackson.databind.exc.MismatchedInputException

目录&#xff1a; 1、错误现象2、解决办法3、最终验证 1、错误现象 报错的现象和代码如下&#xff1a; 2、解决办法 查了很多都说参数类型对不上&#xff0c;但是明明是对上的&#xff0c;没有问题&#xff0c;最后只有换接收方式后验证是可以的&#xff1b;最终想了一下&…

【Unity】【游戏开发】游戏引擎是如何模拟世界的

【核心感悟】 游戏引擎通过两个维度的合并来模拟这个时间。 一个维度叫物理模型。 一个维度叫视觉模型。 对于物理模型&#xff0c;我们需要用物理引擎给予行为。 对于视觉模型&#xff0c;我们需要用动画去给予行为。 物理模型是真实机制&#xff0c;视觉模型是艺术表现&…

Unity3D 观察者模式

Unity3D 泛型事件系统 观察者模式 观察者模式是一种行为设计模式&#xff0c;通过订阅机制&#xff0c;可以让对象触发事件时&#xff0c;通知多个其他对象。 在游戏逻辑中&#xff0c;UI 界面通常会监听一些事件&#xff0c;当数据层发生变化时&#xff0c;通过触发事件&am…

网络参考模型总结

物理层&#xff1a; 电信号&#xff0c;有中继器、集线器等设备。 数据链路层&#xff1a;帧&#xff0c;有网桥、交换机等设备&#xff0c;通过mac地址。 网络层&#xff1a;包&#xff0c;有路由器等设备&#xff0c;通过IP地址。 传输层&#xff1a;段&#xff0c;有网…

权限管理系统的详细解析与实现

1. 权限管理的基础概念 1.1 什么是权限管理&#xff1f; 权限管理是指通过对用户身份的验证和权限的分配&#xff0c;控制用户对系统资源的访问范围和操作权限。它主要包括&#xff1a; 认证&#xff1a;确认用户的身份是否合法&#xff0c;通常通过用户名/密码或多因子验证…

rootless模式下istio ambient的流量管理测试

接上一篇rootless模式下istio ambient鉴权策略&#xff0c;本次测试管理流量的功能。 服务流量分割 Bookinfo应用程序有三个版本的reviews服务&#xff0c;接下来对这些版本进行分配流量控制测试。 longtdsubuntu:~$ kubectl get pod |grep reviews reviews-v1-746f96c9d4-2…

多入口+vite+vue3预渲染方案

如果你的项目要求加载速度要快,我们如果使用传统的vue3+sfc模式去开发,因为只有一个根节点,空白页面加载出来之后js才回去加载组件渲染,这样页面总是有一个短暂的空白。我们这里不讨论服务器端ssr和预渲染方案,仅仅是为了满足比较极端的优化需求,在这种情况下我的这套方案…

出类拔萃的四款录屏工具你pick哪一个?

在这个屏幕时代&#xff0c;录屏已经成为我们日常工作和娱乐中不可或缺的一部分。无论是为了记录游戏精彩瞬间&#xff0c;还是为了分享教程和经验&#xff0c;一个好的录屏工具都是必不可少的。今天&#xff0c;就让我为大家推荐几款电脑免费录屏工具&#xff0c;并分享一下使…

DDD通用语言、多尿和尿频-《分析模式》漫谈41

“Analysis Patterns”的第3章有这么一句&#xff1a; A patient with observations of the presence of thirst, weight loss, and polyuria indicates diabetes. 2004&#xff08;机械工业出版社&#xff09;中译本的译文为&#xff1a; 虽然没有完全使用类图&#xff08;类…

Ajax是什么?

Ajax是什么&#xff1f; Ajax是创建交互式网页应用的网页开发技术。简单来说就是网页在不加载的情况下&#xff0c;可以跟服务器交换数据&#xff0c;并更新页面的内容。 原理&#xff1a; 1. 创建xhr&#xff08;xmlHttpRequest&#xff09;对象; 2, 通过xhr对象的open()方法和…