apidoc-javadoc-generatorRESTful 风格 API 文档生成工具
apidoc-javadoc-generator
一、项目介绍
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>
评论
APIdoc-GoRESTful API 文档生成工具
APIdoc是一个简单的RESTfulAPI文档生成工具,它从代码注释中提取特定格式的内容,生成文档。目前支持支持以下语言:C#、C/C++、Go、Java、Javascript、Perl、PHP、P
APIdoc-GoRESTful API 文档生成工具
0
API-docRESTful API 文档生成工具
RESTful API 标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发
API-docRESTful API 文档生成工具
0
API-docRESTful API 文档生成工具
RESTfulAPI标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发者查阅。1.遵循OpenAPI规范编写RESTfulAPI的接口定义2.生成直观的HTML和PDF格式的
API-docRESTful API 文档生成工具
0
APIdoc-GoRESTful API 文档生成工具
APIdoc是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容,生
APIdoc-GoRESTful API 文档生成工具
0
YUI DocJavaScript API文档生成工具
YUIDoc 是一个基于 Node.js 的应用程序,用来根据 JavaScript 的注释中生成
YUI DocJavaScript API文档生成工具
0
JApiDocsJava 的 Api 文档生成工具
简介JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具。最大程度地利用 Jav
JApiDocsJava 的 Api 文档生成工具
0
JApiDocsJava 的 Api 文档生成工具
简介JApiDocs是一个符合Java编程习惯的Api文档生成工具。最大程度地利用Java的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs会帮你导出一份漂亮的Html文档,并生成相关
JApiDocsJava 的 Api 文档生成工具
0
smart-docJava Restful API 文档生成工具
smart-doc是一款同时支持JAVARESTAPI和ApacheDubboRPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念,完全基于接口源码来分析生成接口文
smart-docJava Restful API 文档生成工具
0