前言
程序员一直以来都有一个烦恼，只想写代码，不想写文档。代码就表达了我的思想和灵魂。 Python提出了一个方案，叫docstring，来试图解决这个问题。即编写代码，同时也能写出文档，保持代码和文档的一致。docstring说白了就是一堆代码中的注释。Python的docstring可以通过help函数直接输出一份有格式的文档，本工具的思想与此类似。
代码即文档
Apiggs是一个非侵入的RestDoc文档生成工具。工具通过分析代码和注释，获取文档信息，生成RestDoc文档。
有这样一段代码
/**
* Building a RESTful Web Service
* 来自spring的官方示例:https://spring.io/guides/gs/rest-service/
*/
@RestController
public class GreetingController {
private static final String template = "Hello, %s!";
private final AtomicLong counter = new AtomicLong();
/**
* Web Endpoint greeting
* @param name who is this
* @return
*/
@RequestMapping("/greeting")
public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {
return new Greeting(counter.incrementAndGet(),
String.format(template, name));
}
}
运行插件
gradle 运行 task: Tasks/documentation/apiggs
maven 运行 compile
生成文档
在编译目录下生成apiggs文件夹，并生成三个文件：
1. .json文件，可直接导入postman
1. .adoc文件，Asciidoc源文件
1. .html文件，源文件渲染结果，效果如下图
查看更多信息：Wiki
-
程序员最讨厌的两件事：一是别人的代码没有文档，二是给自己的代码写文档。 有买卖就有伤害 有需求就有市场，比如swagger就可以自动生成文档，但是swagger是侵入式的，和业务代码混在一起，而apiggs是一个非侵入式的maven插件，可以生成三种格式的文档： html：api文档 json：可直接导入postman adoc：一种asciidoc文档，可用文件处理器转换成其它格式文档，如htm
-
spring-boot 一款无侵入型，轻量级的接口文档生成工具apiggs 名字叫：apiggs 使用只需两步，先把插件代码引入pom文件，然后编译打包即可 之后项目的target目录下，就会多出一个apiggs的文件夹，里面便是项目controller的文档 github上有源码：https://github.com/apigcc/apigcc-maven-plugin <build>
-
restdoc 是基于gin和angular的开源API文档管理工具，前端部分/后端部分见 https://github.com/restdoc/restdoc-server 。 安装依赖 npm i 运行 ng serve --live-reload --port=4208访问 http://127.0.0.1:4208 效果预览
-
本文向大家介绍C++编写非侵入式接口，包括了C++编写非侵入式接口的使用技巧和注意事项，需要的朋友参考一下 终于写到c++的非侵入式接口了，兴奋，开心，失望，解脱，…… 。在搞了这么多的面向对象科普之后，本人也已经开始不耐烦，至此，不想做太多阐述。 虽然，很早就清楚怎么在c++下搞非侵入式接口，但是，整个框架代码，重构了十几次之后，才终于满意。支持给基本类型添加接口，好比int，char，cons
-
本文向大家介绍Python文档生成工具pydoc使用介绍，包括了Python文档生成工具pydoc使用介绍的使用技巧和注意事项，需要的朋友参考一下 在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc. pydoc是Python自带的模块，
-
https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统，参考
-
easyopen提供一个简单的api文档查看页面，类似于swagger，基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明，也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示： 左边的树形菜单对应文档名称，点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的，需要
-
CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档，注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境（cabal.debug配置为true）下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =