程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Apiggs(非侵入的 RestDoc 文档生成工具)、zyplayer-doc-db(只需 2 步操作的数据库文档工具)、Regan API SpringBoot(基于注释自动生成 API 文档)。

1、Apiggs(非侵入的 RestDoc 文档生成工具)

前言:

程序员一直以来都有一个烦恼,只想写代码,不想写文档。代码就表达了我的思想和灵魂。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文件,源文件渲染结果,效果如下图:

程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot介绍

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

2、zyplayer-doc-db(只需 2 步操作的数据库文档工具)

项目介绍:

数据库文档工具,网页方式管理,只需两步即可对表注释、字段注释进行查看、修改等操作,支持字段或注释的模糊查询,只有一个单独的页面,方便集成到已有的管理系统里面,本工具不对数据源进行管理,因为后台管理系统肯定是已有的数据源,没必要再来创建,只需要注入数据源即可管理,不断增加更多实用功能中

使用方式:

1]、添加注解:@EnableDocDb

2]、注入Bean

// 注入已有的数据源

@Resource DataSource orderDatasource;

@Resource DataSource userDatasource;

//....

@Bean

public DatabaseRegistrationBean databaseRegistrationBean() {

DatabaseRegistrationBean bean = new DatabaseRegistrationBean();

List<DataSource> dataSourceList = new LinkedList<>();

// 设置需要展示的数据源

dataSourceList.add(orderDatasource);

dataSourceList.add(userDatasource);

bean.setDataSourceList(dataSourceList);

return bean;

}

打开网页访问域名地址+doc-db.html即可,例:http://192.168.0.100:8080/doc-db.html

界面展示:

基本界面:

程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot介绍

模糊查询:

程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot介绍

表注释修改:

程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot介绍

下载地址:https://gitee.com/zyplayer/zyplayer-doc-db

3、Regan API SpringBoot(基于注释自动生成 API 文档)

项目介绍:

Regan_API_SpringBoot 文档项目 Regan API 项目是基于注释自动生成api文档,很大缩短了开始与后期维护API接口文档的时间。Regan API 利用jdk提供的Doclet 类读取文档注释,可手动配置需要读取的文件,同时增加了读取过滤指定方法过滤等功能。

程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot介绍

程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot介绍

软件架构:

Regan API 基础项目基于 springboot 开发,前端基于飞冰开发的API接口文档管理项目。

注明

以上就是程序文档工具Apiggs、zyplayer-doc-db、Regan API SpringBoot的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章