Java非侵入式API接口文档工具apigcc用法详解
更新时间：2020年07月06日 09:15:57 作者：BarryW
这篇文章主要介绍了Java非侵入式API接口文档工具apigcc用法详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
一个非侵入的api编译、收集、Rest文档生成工具。工具通过分析代码和注释，获取文档信息，生成RestDoc文档
前言
程序员一直以来都有一个烦恼，只想写代码，不想写文档。代码就表达了我的思想和灵魂。
Python提出了一个方案，叫docstring，来试图解决这个问题。即编写代码，同时也能写出文档，保持代码和文档的一致。docstring说白了就是一堆代码中的注释。Python的docstring可以通过help函数直接输出一份有格式的文档，本工具的思想与此类似。
代码即文档
Apigcc是一个非侵入的RestDoc文档生成工具。工具通过分析代码和注释，获取文档信息，生成RestDoc文档。
有这样一段代码
/**
* 欢迎使用Apigcc
* @index 1
*/
@RestController
public class HelloController {
/**
* 示例接口
* @param name 名称
* @return
*/
@RequestMapping("/greeting")
public HelloDTO greeting(@RequestParam(defaultValue="apigcc") String name) {
return new HelloDTO("hello "+name);
}
}
使用方式
apiggs-maven-plugin
easy use apigcc with maven
安装
<plugin>
<groupId>com.github.apiggs</groupId>
<artifactId>apiggs-maven-plugin</artifactId>
<version><!-- 替换为上方版本号 --></version>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>apiggs</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- options in there -->
</configuration>
</plugin>
when you compile source code, apiggs will build rest doc.
options
- id 项目id，生成id.html文件
- title 文档标题
- description 文档描述
- production 输出文件夹，默认为 apiggs
- out 输出目录，默认为 target
- source 源码目录
- dependency 源码依赖的代码目录，以逗号隔开
- jar 源码依赖的jar包目录，以逗号隔开
- ignore 忽略某些类型
- version 文档版本号
执行方法：
查看API文档：
另外，也可以放入容器远程访问，方法如下：
运行项目
gradlew build
cd service\build\libs
java -jar apigcc-hub-{version}.jar
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
相关文章
这篇文章主要介绍了基于Java8实现提高Excel读写效率,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-11-11
SpringBoot中使用configtree读取树形文件目录中的配置详解
这篇文章主要介绍了SpringBoot中使用configtree读取树形文件目录中的配置详解,configtree通过spring.config.import + configtree:前缀的方式,加载以文件名为key、文件内容为value的配置属性,需要的朋友可以参考下2023-12-12
这篇文章主要介绍了使用dom4j解析xml文件问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-09-09
这篇文章主要介绍了JVM运行时数据区原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-08-08
分析并解决Intellij IDEA覆盖tomcat配置的问题/解决修改server.xml无效的问题，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友一起看看吧2021-02-02
这篇文章主要介绍了Java设计模式之备忘录模式的使用,备忘录模式中的发起者和管需要的朋友可以参考下2016-02-02
这篇文章主要给大家介绍了关于JAVA为什么要使用封装及如何封装的相关资料,封装就是将属性私有化,提供公有的方法访问私有属性,文中通过代码介绍的非常详细,需要的朋友可以参考下2023-10-10
这篇文章主要介绍了springmvc流程图以及配置解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-09-09
浅析Bean Searcher 与 MyBatis Plus 区别介绍
Bean Searcher号称任何复杂的查询都可以一行代码搞定，但 Mybatis Plus 似乎也有类似的动态查询功能，最近火起的 Bean Searcher 与 MyBatis Plus 倒底有啥区别？带着这个问题一起通过本文学习下吧2022-05-05
Lombok注解之@SuperBuilder--解决无法builder父类属性问题
这篇文章主要介绍了Lombok注解之@SuperBuilder--解决无法builder父类属性问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-09-09
最新评论