程序文档工具swammdoc、apidoc-javadoc-generator、JApiDocs介绍

以下为你介绍的程序文档工具都可用在Linux系统上:swammdoc(接口文档自动生成工具)、apidoc-javadoc-generator(RESTful 风格 API 文档生成工具)、JApiDocs(Java 的 Api 文档生成工具)。

1、swammdoc(接口文档自动生成工具)

swammdoc-接口文档自动生成工具。

如图:

程序文档工具swammdoc、apidoc-javadoc-generator、JApiDocs介绍

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

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

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

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

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

下载地址:https://gitee.com/mirrors/swammdoc

2、apidoc-javadoc-generator(RESTful 风格 API 文档生成工具)

一、项目介绍

apidoc是用node.js开发的可以根据api的注释文档生成相应的RESTful风格的api文档的工具,而且支持多种开发api的语言。使用apidoc时生成文档时需要 3 步(默认使用者已经安装了node.js、apidoc,如果没有可以根据这个来完成:node.js,v6版本的node.js安装后会把npm也装好,apidoc install)。

完成api的注释文档。

完成apidoc.json(这一步可省略)。

使用命令apidoc -i doc_dir -o output_dir run,在哪个目录下执行这个命令,apidoc.json放在哪个目录就行,就可生成漂亮美观的api文档了。

这个项目就是实现的就是可以根据java的注解和maven插件配置来生成apidoc注释的maven插件,即完成上面的第一步,也是最烦人的一步, 而且只支持使用spring mvc框架来开发的api。

二、使用介绍

1、把项目down下来,然后maven install到本地maven仓库(也可deploy到maven私服,供他人使用)

D:\apidoc-javadoc-generator>mvn install -Dmaven.test.skip=true

2、在自己的项目中引入依赖和插件

<dependency>

<groupId>com.cmy</groupId>

<artifactId>apidoc-javadoc-generator-core</artifactId>

<version>0.0.1</version>

</dependency>

<build>

<plugins>

<plugin>

<groupId>com.cmy</groupId>

<artifactId>apidoc-javadoc-generator-maven-plugin</artifactId>

<version>0.0.1</version>

<dependencies>

<!-- 插件依赖于spring mvc,如果自己项目里引入了别的依赖也可以在这里添加 -->

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-web</artifactId>

<version>${spring.version}</version>

</dependency>

<dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-core</artifactId>

<version>${spring.version}</version>

</dependency>

</dependencies>

<configuration>

<apiDocFileName>ApiDocContent</apiDocFileName>

<apiDocDir>src\test\java</apiDocDir>

<apiSources>

<apiSource>com.cmy.controller.XxController</apiSource>

</apiSources>

</configuration>

</plugin>

</plugins>

</build>

下载地址:https://gitee.com/mirrors/apidoc-javadoc-generator

3、JApiDocs(Java 的 Api 文档生成工具)

JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具。最大程度地利用 Java 的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs 会帮你导出一份漂亮的 Html 文档,并生成相关的 Java 和 Object-C 相关数据模型代码,从此,Android 和 IOS 的同学可以少敲很多代码了,你也不需要费力维护接口文档的变化,只需要维护好你的代码就可以了。

特性:

以一个 Controller 作为一组接口导出到一个 Html 文件中。

支持生成 Java 和 Object-C 语言的 Response 模型代码。

深度支持 Spring Boot, PlayFramework,JFinal,不需要额外声明路由。

支持一般的 Java Web 工程,需要在相关方法添加额外的路由。

支持接口声明过时(@Deprecated),方便的文档目录等。

支持自定义代码生成模板。

下载地址:https://gitee.com/yeguozhong/JApiDocs

注明

以上就是程序文档工具swammdoc、apidoc-javadoc-generator、JApiDocs的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章