解析Java代码,自动生成文档工具使用说明

简介: 页面布局左侧为菜单,菜单分为两级,一级表示模块,二级表示接口信息右侧为接口详细信息,主要包括:模拟测试功能,接口详细信息说明,请求参数说明,响应参数说明,自动一个演示的例子表明接口的使用方式如下图(图片拼接左侧菜单可能模糊或重影,凑合看):...

页面布局

  1. 左侧为菜单,菜单分为两级,一级表示模块,二级表示接口信息
  2. 右侧为接口详细信息,主要包括:模拟测试功能,接口详细信息说明,请求参数说明,响应参数说明,自动一个演示的例子表明接口的使用方式
    如下图(图片拼接左侧菜单可能模糊或重影,凑合看):


    img_910cbdcdcfd8c5f2228e9af1af12943a.png
    演示页面布局

页面操作

  1. 左侧二级菜单可以双击修改,失去焦点时自动保存


    img_53f67b6d5e8d1663a28419f0019afd06.png
    image.png
  2. 左侧一级,二级菜单可以拖拽排序


    img_027651b07ddab14b4d386cbcd3cd1b9f.png
  3. 所有带 “编辑”按钮的地方都可以编辑保存,textarea编辑时可以带回车换行,自动记录你的文本格式


    img_bd527f01908bd07a814ac892f72dbc14.png

    img_0ef57389474f58bd5109b23ed15fc0a0.png
  4. 请求参数和响应参数,本身是一个树结构,所有编辑的时候跟普通的编辑树一样操做,包括添加一级数据,添加子数据,修改,删除,保存等等,鼠标移入会有提示,如下图


    img_f33da15c1b0790e3d98de42889ce6d65.png

    5.如果需要给接口提供默认值,修改参数的默认值后,会自动重构json参数,方便测试


    img_e59babf9d820b78c5a33e8b2770c1af5.png

代码使用

  1. 在你的controller类上增加注解@Api("这里写模块名称"),这里一个@Api对应页面的一个一级菜单,即模块,模块可以由多个类组成,只需设置每个类的模块名称一样,程序会自动把模块名称一样的class组装成同一模块。
相关文章
|
20小时前
|
Java Windows
用Java手搓一个转义工具
本文介绍了转义符的概念及其在编程中的作用,如`\n`、`\t`等,用于表示特殊字符。在Java中,通过`Scanner`接收用户输入,利用`escapeString`方法转义字符串中的特殊字符。示例代码展示了如何实现这一功能,读取用户输入,转义后打印结果。
10 2
|
1天前
|
存储 Java
【JAVA学习之路 | 进阶篇】ArrayList,Vector,LinkedList内存解析
【JAVA学习之路 | 进阶篇】ArrayList,Vector,LinkedList内存解析
|
1天前
|
存储 Java 测试技术
滚雪球学Java(37):深入了解Java方法作用域和生命周期,让你写出更高效的代码
【5月更文挑战第12天】🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
10 0
滚雪球学Java(37):深入了解Java方法作用域和生命周期,让你写出更高效的代码
|
2天前
|
Java
Java程序设计基础——条件运算符的深入解析
Java程序设计基础——条件运算符的深入解析
|
2天前
|
并行计算 Java 大数据
Java 8新特性解析及应用
【5月更文挑战第21天】本文将深入探讨Java 8的新特性,包括Lambda表达式、Stream API、Optional类以及新的日期时间API。我们将详细解析这些特性的使用方法和应用场景,帮助读者更好地理解和应用Java 8的新特性。
|
2天前
|
监控 Java 开发者
Java一分钟之-Java性能分析与调优:JProfiler, VisualVM等工具
【5月更文挑战第21天】本文介绍了Java性能优化的两个利器——JProfiler和VisualVM。JProfiler通过CPU Profiler、内存分析器和线程视图帮助解决过度CPU使用、内存泄漏和线程阻塞问题;VisualVM则聚焦于GC行为调整和类加载优化,以减少内存压力和提高应用性能。使用这些工具进行定期性能检查,是提升Java应用效率的关键。
17 0
|
2天前
|
Java 编译器
滚雪球学Java(36):玩转Java方法重载和可变参数,让你的代码更灵活
【5月更文挑战第11天】🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
8 0
滚雪球学Java(36):玩转Java方法重载和可变参数,让你的代码更灵活
|
4天前
|
Java 测试技术
如何提高Java代码的可读性
Java是一种常用的编程语言,但是写出易懂且可读性高的代码却是一项挑战。本文将分享一些技巧和建议,帮助您提高Java代码的可读性和可维护性。
|
6天前
|
Linux 网络安全 Windows
网络安全笔记-day8,DHCP部署_dhcp搭建部署,源码解析
网络安全笔记-day8,DHCP部署_dhcp搭建部署,源码解析
|
7天前
HuggingFace Tranformers 源码解析(4)
HuggingFace Tranformers 源码解析
11 0

推荐镜像

更多