接口文档自动生成工具 swammdoc

码农软件 · 软件分类 · 程序文档工具 · 2019-12-10 12:59:29

软件介绍

swammdoc

接口文档自动生成工具

如图:

 输入图片说明

团队协作离不开约定,规范,最早我们用word,excel编写接口文档,现在有了开源,涌现了一批接口文档管理平台, rap , 小幺鸡, apiManager等等, 有了更友好结构化展示,版本历史, mock等等好用功能。

问题来了, 写好了代码怎么维护到api管理平台上,只能手工操作。或者自已定义一套注解库,用来标识请求参数,返回参数,这样对代码的侵入性又有点太强了。

javadoc 这个功能似乎被我们怱略了,连身边朋友都没见有人在用这个。javadoc 提供了很强劲的分析源码的功能,参数类型, 返回类型, 泛型等等,统统可以取到, 请求参数,返回参数出现循环引用问题, 目前限制到4层。

第一个版本对接了rap , 后来在使用过程中,rap越来越慢,最后迁到小幺鸡,原来内部使用shell脚本执行, 这一个版本使用maven 插件的形式,现在还处理初级阶段,有兴趣的朋友可以修改,自己使用。

有兴趣的朋友可以了解一下javadoc的使用方式, 这个工具使用也是建立在javadoc之上,maven插件也是在maven javadoc 插件的基础上。

本文地址:https://codercto.com/soft/d/20840.html

互联网+ 战略版

互联网+ 战略版

刘润 / 中国华侨出版社 / 2015-5-1 / 49.8

1、“互联网+”上升为国家战略,“互联网+”成为下一个超级畅销书的热点话题在商业环境巨变的今天,传统企业该怎么走?传统企业转型是一个系统工程,如何定战略、抓主要矛盾? 2、首本“互联网+传统企业”的战略指导书。“我互联网+”时代到来了,传统企业的外部环境发生了哪些变化?了解商业新生代的新商业环境,跟之前工业时代的不同,从战略上指导传统企业转型,更安全也更大局把握游刃有余。一起来看看 《互联网+ 战略版》 这本书的介绍吧!

在线进制转换器
在线进制转换器

各进制数互转换器

URL 编码/解码
URL 编码/解码

URL 编码/解码

html转js在线工具
html转js在线工具

html转js在线工具