还在为Swagger添加一堆描述注解苦恼么?零注解方案推荐
yuyutoo 2024-10-12 01:50 3 浏览 0 评论
不知各位程序猿在输出接口文档的时候,有这样苦恼的问题:
- 需要给前端输出接口对接文档,但系统暂时没有,只能手写
- 有swagger方式,但是每写一个接口,一堆的@ApiOperation、@ApiModelProperty(value = "Desc")等等,实际上也是在写文档
- 某些系统因为初期根本没有考虑,压根就不支持
那是否有懒人解决方案,不用动手,直接搞定的方案呢?
JApiDocs 能够解决上述问题,直接上图:
具体工程改造过程:
- 引入Maven依赖
<dependency>
<groupId>io.github.yedaxia</groupId>
<artifactId>japidocs</artifactId>
<version>1.4.4</version>
</dependency>
- 添加初始化配置
import io.github.yedaxia.apidocs.Docs;
import io.github.yedaxia.apidocs.DocsConfig;
import org.springframework.context.annotation.Configuration;
import java.util.Locale;
/**
* api 配置,用于接口文档生成
*
* @author : frank.nie@sina.com
* @date : created in 2021/11/3 16:09
*/
@Configuration
public class ApiConfig {
public ApiConfig() {
DocsConfig cfg = new DocsConfig();
// 实际代码工程所在路径
cfg.setProjectPath("D:\\work\\workspace\\platform\\task-monitor");
// api文档版本信息
cfg.setApiVersion("V1.0");
// 项目描述
cfg.setProjectName("任务管理");
// api文档生成目录
cfg.setDocsPath("D:\\work\\workspace\\platform\\task-monitor\\apidocs");
// 自动生成文档
cfg.setAutoGenerate(Boolean.TRUE);
cfg.setLocale(Locale.SIMPLIFIED_CHINESE);
// docsConfig.addPlugin(new MarkdownDocPlugin());
// 添加全局配置
Docs.buildHtmlDocs(cfg);
}
}
至此,完成系统改造!然后运行程序,即可生成api接口文档
本文实例Controller代码如下:
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.Serializable;
import java.util.List;
/**
* 接口文档样例
*
* @author : frank.nie@sina.com
* @date : created in 2021/11/3 16:07
*/
@Slf4j
@RestController
@RequestMapping("/api/task/")
public class TaskController {
@Data
public static class TaskForm implements Serializable {
/**
* 任务id
*/
String id;
/**
* 任务名称
*/
String name;
/**
* 任务描述
*/
String desc;
}
/**
* 任务查询
*
* @return 查询的任务信息
*/
@PostMapping("query")
public ResponseEntity queryTask() {
return ResponseEntity.ok("OK");
}
/**
* 任务新增
*
* @param t 新增任务入参
* @return ok-成功,failed-失败
*/
@PostMapping("add")
public ResponseEntity addTask(TaskForm t) {
return ResponseEntity.ok("OK");
}
/**
* 任务删除
*
* @param form 待删除的任务信息
* @return ok-成功,failed-失败
*/
@PostMapping("delete")
public ResponseEntity deleteTask(List<TaskForm> form) {
return ResponseEntity.ok("OK");
}
/**
* 任务修改
*
* @param form 待更新的任务
* @return ok-成功,failed-失败
*/
@PostMapping("update")
public ResponseEntity updateTask(TaskForm form) {
return ResponseEntity.ok("OK");
}
}
最终效果如下:
注意问题:
- 暂时只支持 ≥ JDK1.8
- 注意设置好工程的编码格式UTF-8
相关问题,欢迎留言提问;欢迎大家点赞、关注、收藏~
相关推荐
- 如何在HTML中使用JavaScript:从基础到高级的全面指南!
-
“这里是云端源想IT,帮你...
- 推荐9个Github上热门的CSS开源框架
-
大家好,我是Echa。...
- 硬核!知网首篇被引过万的论文讲了啥?作者什么来头?
-
整理|袁小华近日,知网首篇被引量破万的中文论文及其作者备受关注。知网中心网站数据显示,截至2021年7月23日,由华南师范大学教授温忠麟等人发表在《心理学报》2004年05期上的学术论文“中介效应检验...
- 为什么我推荐使用JSX开发Vue3_为什么用vue不用jquery
-
在很长的一段时间中,Vue官方都以简单上手作为其推广的重点。这确实给Vue带来了非常大的用户量,尤其是最追求需求开发效率,往往不那么在意工程代码质量的国内中小企业中,Vue占据的份额极速增长...
-
- 【干货】一文详解html和css,前端开发需要哪些技术?
-
网站开发简介...
-
2025-02-20 18:34 yuyutoo
- 分享几个css实用技巧_cssli
-
本篇将介绍几个css小技巧,目录如下:自定义引用标签的符号重置所有标签样式...
- 如何在浏览器中运行 .NET_怎么用浏览器运行代码
-
概述:...
- 前端-干货分享:更牛逼的CSS管理方法-层(CSS Layers)
-
使用CSS最困难的部分之一是处理CSS的权重值,它可以决定到底哪条规则会最终被应用,尤其是如果你想在Bootstrap这样的框架中覆盖其已有样式,更加显得麻烦。不过随着CSS层的引入,这一...
-
- HTML 基础标签库_html标签基本结构
-
HTML标题HTML标题(Heading)是通过-...
-
2025-02-20 18:34 yuyutoo
- 前端css面试20道常见考题_高级前端css面试题
-
1.请解释一下CSS3的flexbox(弹性盒布局模型),以及适用场景?display:flex;在父元素设置,子元素受弹性盒影响,默认排成一行,如果超出一行,按比例压缩flex:1;子元素设置...
- vue引入外部js文件并使用_vue3 引入外部js
-
要在Vue中引入外部的JavaScript文件,可以使用以下几种方法:1.使用``标签引入外部的JavaScript文件。在Vue的HTML模板中,可以直接使用``标签来引入外部的JavaScrip...
- 网页设计得懂css的规范_html+css网页设计
-
在初级的前端工作人员,刚入职的时候,可能在学习前端技术,写代码不是否那么的规范,而在工作中,命名的规范的尤为重要,它直接与你的代码质量挂钩。网上也受很多,但比较杂乱,在加上每年的命名都会发生一变化。...
- Google在Chrome中引入HTML 5.1标记
-
虽然负责制定Web标准的WorldWideWebConsortium(W3C)尚未宣布HTML5正式推荐规格,而Google已经迁移到了HTML5.1。即将发布的Chrome38将引入H...
- HTML DOM 引用( ) 对象_html中如何引用js
-
引用对象引用对象定义了一个同内联元素的HTML引用。标签定义短的引用。元素经常在引用的内容周围添加引号。HTML文档中的每一个标签,都会创建一个引用对象。...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)