java 非侵入式_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

安装

com.github.apiggs

apiggs-maven-plugin

compile

apiggs

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文档：

另外，也可以放入容器远程访问，方法如下：

这里提供了一个已打好的jar

运行项目

gradlew build

cd service\build\libs

java -jar apigcc-hub-{version}.jar

浏览器访问http://127.0.0.1:8080

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持聚米学院。

java 非侵入式_Java非侵入式API接口文档工具apigcc用法详解相关推荐

java扫描接口_一种扫描接口并生成可调用API接口文档的方法与流程
本发明属于JavaWeb开发技术领域,涉及一种API接口文档的生成方法,尤其是一种扫描接口并生成可调用API接口文档的方法. 背景技术: API(Application Programming Int ...
扔掉Swagger，试试这款功能强大，零注解侵入的API接口文档生成工具！
欢迎关注方志朋的博客,回复"666"获面试宝典介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-d ...
在html文件中集成easy,easyapi 通过java注解或注释自动生成带页面的接口文档
Java-自动生成带页面可调试的接口文档介绍:一款java接口文档自动生成的插件,包含了根据接口注释或注解自动生成接口文档,可网页打开. 特点:一款无任何代码侵入的生成方式,10秒钟集成 1.支持读 ...
java 接口文档工具_一款Java基于注释的接口文档生成工具
一. 痛点你还在手动维护接口文档嘛,花一个下午不停的复制粘贴代码里面的注释接口字段变动,还得去更新文档,更新不及时导致文档不同步或者你使用了swagger之类的基于注解,依靠运行时的文档工具,看 ...
作为Java开发工程师，如何高效优雅地编写接口文档
作为一名优秀的Java开发工程师,编写接口文档向来是一件很头疼的事情.本来就被bug纠缠的很累了,你还让我干这? 其实,你可以试试ApiPost. ApiPost的定位是Postman+Swagger ...
java适配器有哪些_Java中适配器模式（Adapter）是什么？适配器模式（详解）
本篇文章给大家带来的内容是Java中适配器模式(Adapter)是什么? 适配器模式(详解).有一定的参考价值,有需要的朋友可以参考一下,希望对你们有所助. 目的:把源类型适配为目标类型,以适应客户端 ...
java excel 插入文件_Java 添加OLE对象到Excel文档
本文介绍通过Java程序添加OLE对象到Excel文档.OLE分为两种形式,一种通过嵌入(Embed),方式,一种通过链接(Link)方式.前者是将对象嵌入到文档中,外部对该对象的更改不影响嵌入操作时 ...
java itext 里表格_Java使用itext5实现PDF表格文档导出
最近拿到一个需求,需要导出PDF文档,市面上可以实现的方法有很多,经过测试和调研决定使用itext5来实现,话不多说,说干就干. 1.依赖导入 com.itextpdf itextpdf 5.5.13 ...
java list 遍历查找_Java用list储存，遍历，查询指定信息过程详解
需求说明实现思路见代码注释代码内容使用list储存,遍历,查询,删除 import java.util.ArrayList; import java.util.List; /** * @aut ...

java 非侵入式_Java非侵入式API接口文档工具apigcc用法详解

java 非侵入式_Java非侵入式API接口文档工具apigcc用法详解相关推荐

最新文章

热门文章