swammdoc

接口文档自动生成工具
授权协议 GPL
开发语言 Java
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 劳麒
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

swammdoc

接口文档自动生成工具

如图:

 输入图片说明

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

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

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

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

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

 相关资料
  • CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档,注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境(cabal.debug配置为true)下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =

  • An expert is someone who is one page ahead of you in the manual. — David Knight 像大多数工程师一样,我从来没有阅读过手册,除非或者直到产品实际出现了十万火急的情况。 然而,随着你的配置清单代码不断增多且越来越复杂,使用 Puppet 的自动文档工具 puppet doc 为你的节点(node)和类(class)生成 H

  • 接口管理平台(Netease Easy Interface),简称 NEI。NEI 虽然叫接口管理平台,但其实不只是管理接口,它可以管理整个产品,也具备项目脚手架的功能。本文介绍 NEI 的设计理念和一些名词的含义。

  • 自动生成接口的Service方法共有七个,分别为create,delete,update,get,getListWithPagingAndFilter,getListWithPagingAndFilter,countListWithPagingAndFilter 文档中入pageNo,pageSize,sortItem,sortOrder,filters,includes,refers,rela

  • 我谷歌了一下,但是所有关于昂首阔步留档的例子都使用了类。我想包括接口,因为读者感兴趣的是API而不是实现。 这是我的密码: 包括所需的maven依赖项: 我的SpringBoot应用程序: 我的RestController接口 和实施 这一切都由所需的昂首阔步配置支持: 该代码可作为maven项目在https://github.com/MKhotele/spring-examples/tree/m

  • 安装配置KnpSnappyBundle扩展 先安装扩展,执行: composer require knplabs/knp-snappy-bundle 再安装wkhtmltopdf工具 wget http://download.gna.org/wkhtmltopdf/0.12/0.12.3/wkhtmltox-0.12.3_linux-generic-amd64.tar.xz xz -d wkh

  • 本文向大家介绍SpringBoot+Swagger-ui自动生成API文档,包括了SpringBoot+Swagger-ui自动生成API文档的使用技巧和注意事项,需要的朋友参考一下 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。 这样后段开发好了api 之后就要提交api 文档给前端的朋友。给前端的a

  • 是否可以使用Azure函数自动生成OpenAPI文档,例如,在ASP中使用Swashback时,如何使用Swagggen。净核心?文档应包含不同的endpoint及其可能的输入和响应模型以及状态代码。如果我能在web ui中查看文档,那就太棒了。 目前,我发现了两个可能的方案: 针对Azure功能的虚张声势的调整:https://github.com/vitalybibikov/AzureExte