2024年1月Java项目开发指南17:自动接口文档配置

Knife4j 文档 :https://doc.xiaominfo.com/

有能力的建议自己去看文档配置,本文仅做参考,因为官方文档会更新,本文不会,以后说不定本文就过时了。

ok,我们继续。虽然本文是2024年1月Java项目开发指南17,但实际上与前面的并没有什么关联(不是基于之前的项目的),这一点需要你知道。

导入依赖:

		<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId><version>4.5.0</version></dependency>

配置(properties):

# springdoc-openapi
springdoc.swagger-ui.path= /swagger-ui.html
springdoc.swagger-ui.tags-sorter= alpha
springdoc.swagger-ui.operations-sorter= alpha
springdoc.api-docs.path= /v3/api-docs
springdoc.group-configs[0].group= 'default'
springdoc.group-configs[0].paths-to-match= '/**'
springdoc.group-configs[0].packages-to-scan= 'com.guaiguailang.harmony.**'

注意:packages-to-scan 的值 要改成符合自己的项目,不要照抄

如果你配置文件不是这种格式,另外一种格式(yml)如下:

# springdoc-openapi项目配置
springdoc:swagger-ui:path: /swagger-ui.htmltags-sorter: alphaoperations-sorter: alphaapi-docs:path: /v3/api-docsgroup-configs:- group: 'default'paths-to-match: '/**'packages-to-scan: com.xiaominfo.knife4j.demo.web
# knife4j的增强配置,不需要增强可以不配
knife4j:enable: truesetting:language: zh_cn

注意:packages-to-scan 的值 要改成符合自己的项目结构信息

就这样就可以了,还可以搞点有意思的,就是运行的时候输出文档地址,效果就像这样:

image

那么怎么做呢,首先配置文件要有:


# Server Info Setting
server.port=8080
server.servlet.context-path=/
server.servlet.session.timeout=3600

然后在启动文件里面写:

package com.guaiguailang.harmony;import com.github.yitter.contract.IIdGenerator;
import com.github.yitter.contract.IdGeneratorOptions;
import com.github.yitter.idgen.YitIdHelper;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;@SpringBootApplication
public class HarmonyLifeServerApplication {public static void main(String[] args) {
//		SpringApplication.run(HarmonyLifeServerApplication.class, args);// 启动 Spring Boot 应用ConfigurableApplicationContext context = SpringApplication.run(HarmonyLifeServerApplication.class, args);// 获取服务器端口int port = context.getEnvironment().getProperty("server.port", Integer.class);// 获取服务器上下文路径,默认为"/"String contextPath = context.getEnvironment().getProperty("server.servlet.context-path", "/");if (contextPath.equals("/")) {contextPath = "";}System.out.println("^_^ 青山埋忠骨,烟巷葬伟杰        ORZ···");System.out.println("工    作    区  :"+work_space+" (请保证工作区全局唯一)");// 输出项目访问地址System.out.println("访   问  地  址 : http://localhost:" + port + contextPath);// 输出 Swagger 文档地址System.out.println("Swagger 文档地址: http://localhost:" + port + contextPath + "/swagger-ui.html");System.out.println("Knife4j 文档地址: http://localhost:" + port + contextPath + "/doc.html");System.out.println("^_^ 仙之巅 傲世间 先有萌狼后有天    ORZ···");}}

完毕

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

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

相关文章

九宫格(html css实现)---初识flex布局

记录flex属性并实现一个九宫格 flex属性 Flex 容器: 需要注意的是:当时设置 flex 布局之后,子元素的 float、clear、vertical-align 的属性将会失效 .container {display: flex; }//块状元素.container {inline-flex; }//行内元素块状元素 1.*** 独占一行:块元素会自动开…

利用Adguard屏蔽必应搜索中的CSDN内容

### 原因众所周知,CSDN 搜索结果,内容复制需要魔法,有的还需要关注,啥都要钱,质量还特别差虽然 百度和必应可以写参数直接去除CSDN 搜索结果,但每次都要写很麻烦### 解决办法原因 众所周知,CSDN 搜索结果,内容复制需要魔法,有的还需要关注,啥都要钱,质量还特别差 虽…

windows应急响应(二)

1.启动项win+r 输入msconfig,在"工具"里找到“任务管理器”;(底部任务栏右键,也可打开),查看启动项一般应用启动项位置:C:\Users\adnim\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startupwin+r 输入msinfo32,在"软件环境"里可以看到Au…

领导大规模敏捷Leading SAFe认证培训课

领导大规模敏捷Leading SAFe认证课

asio的buffer

ASIO的buffer理解 asio的buffer结构 任何网络库都有提供buffer的数据结构,这个就是收发数据的缓冲区。 asio提供了mutable_buffer 和 const_buffer这两个结构,他们都是一段连续的空间,首字节存储了后续数据的长度。mutable_buffer用于写服务,const_buffer用于读服务。但是这…

格林公式7

例1 计算积分 \[I=\int_Cx^2ydx-xy^2dy, \]其中C是上半圆 \(\begin{aligned} & \text{ }x^2+y^2=a^2,y\geqslant0,\text{ }\\ & \end{aligned}\) 逆时间方向 \[\begin{aligned} & \text{ }x^2+y^2=a^2,y\geqslant0,\text{ }\\ & \end{aligned} \]考虑到上半…

9.21 abc372f

容易发现平移操作,都是 \(to\) 向左平移。然后更新完了过后,\(x\) 再左移。 当然 dp 数组整体是左移的。 本题一个重点就是,假设整个 dp 不动,让我们的操作反着动。

基于AODV和leach协议的自组网络平台matlab仿真,对比吞吐量,负荷,丢包率,剩余节点个数,节点消耗能量

1.算法仿真效果 matlab2017b仿真结果如下(完整代码运行后无水印):本程序系统是《m基于matlab的AODV,leach自组网网络平台仿真,对比吞吐量,端到端时延,丢包率,剩余节点个数,节点消耗能量》的的升级。升级前原文章链接增加了运动节点的路由测试,包括定向运动,随机运动,静止…

笛卡尔坐标张量简介7

张量(tensor) 这一术语最初是用来描述弹性介质各点应力状态的,后来发展成为力学和物理学的一个有力数学工具,目前力学方面的理论性文献都不同程度地这用了这一工具 由坐标原点和三条不共面的标架直线构成的坐标系称为直线坐标系,如果三标架直线上的单位尺度相同,称为笛卡…

尝试RVC音色克隆团长音色

前言 昨晚玩剑网3突发奇想,把团长声音克隆下来,利用语音喵制作成语音DBM。 这样不管团长开不开团,打团也能有团长声音听了诶嘿嘿。 于是当场关闭游戏声音录了打本的素材,本文就边做边记录。 下载 在B站找到了这个教程: 【你的声音,现在是我的了!】https://www.bilibili.…