写了一个生成api文档的小工具_程序人生

admin

2023-07-31 01:51:03

0次

最近我们产品的api变化挺大的，这时候去修改文档就是一个很麻烦的事情。因为有的序列化的工具是通用的，修改一个地方会影响到很多地方，这样要不就是去手动的一个个的改，要不就是忽略不管了。

当然了，实际情况就是只修改了重要的地方，有一些就忽略掉了。我们写文档使用的是confluence，这个其实更侧重于通用的内容分享，而不是写代码文档，所以每次还要自己手动的画表格，然后写url写测试数据和响应数据，太麻烦了。于是下面这个工具就诞生了。

这个工具你要是手动的写上url，测试数据，方法等就能获取到服务器响应，自动的填充，只要点击保存就可以了。

左侧是一个树状的分类，默认是全部展开的。点击分类文件夹在右边展示该文件夹下面所有的api，默认折叠显示，点击可以展开。点击单个的api，可以独立的查看。api和分类都可以编辑删除和修改父节点。

其实这个工具还是一个优点就是可以自动的去更新数据，不过这个功能还没去写。因为有了测试的url和数据了啊。

django python

Mobi、epub格式电子书如... 在wps里全局设置里有一个文件关联，打开，勾选电子书文件选项就可以了。

定时清理删除C:\Progra... C:\Program Files (x86)下面很多scoped_dir开头的文件夹写个批处理定...

scoped_dir32_70... 一台虚拟机C盘总是莫名奇妙的空间用完，导致很多软件没法再运行。经过仔细检查发现是C:\Program...

500 行 Python 代码... 语法分析器描述了一个句子的语法结构，用来帮助其他的应用进行推理。自然语言引入了很多意外的歧义，以我们...

小程序支付时提示：appid和... [Q]小程序支付时提示：appid和mch_id不匹配 [A]小程序和微信支付没有进行关联，访问“小...

pycparser 是一个用... `pycparser` 是一个用 Python 编写的 C 语言解析器。它可以用来解析 C 代码并构...

微信小程序使用slider实现... 众所周知哈，微信小程序里面的音频播放是没有进度条的，但最近有个项目呢，客户要求音频要有进度条控制，所...

65536是2的几次方计算2... 65536是2的16次方：65536=2⁶ 65536是256的2次方：65536=256 6553...

Apache Doris 2.... 亲爱的社区小伙伴们，我们很高兴地向大家宣布，Apache Doris 2.0.0 版本已于...

项目管理和工程管理的区别项目管理项目管理，顾名思义就是专注于开发和完成项目的管理，以实现目标并满足成功标准和项目要求。工...