程序文档工具Swagger-more、kings-rap2-generator、SApidoc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Swagger-more(自动化 DUBBO API 文档)、kings-rap2-generator(淘宝 rap2 插件)、SApidoc(API 文档生成框架)。

1、Swagger-more(自动化 DUBBO API 文档)

界面展示:

程序文档工具Swagger-more、kings-rap2-generator、SApidoc介绍

依旧支持官方的swagger ui。

支持的功能:

1].自动生成dubbo接口文档,同springfox 的JSON API。

2].接口支持调试,支持泛型调用,解决接口方法多对象传参以及方法重载的问题。

3].支持javadoc生成接口信息的注解。

4].兼容springfox swagger2的ui、提供一个符合java接口文档的新UI。

官方只有针对mvc场景下的 WebMvcRequestHandlerProvider 的实现。

Swagger-more添加了对于暴露的dubbo api的接口实现 com.github.uhfun.swagger.extension.ApiRequestHandler

以及其他对于用于构造api文档的一些扩展。

下载地址:https://gitee.com/uhfun/swagger-more

2、kings-rap2-generator(淘宝 rap2 插件)

kings-rap2-generator,基于配置的将实体类一键录入淘宝 rap2 的插件。

特性:

支持实体类解析,包括数字类型、字符串类型、布尔类型、集合、数组、对象。

支持 body 入参和 query 入参。

泛型解析支持。

自定义响应支持。

将解析路径定位到包,配置更加方便。

支持简单的 json 配置来执行脚本。

支持时间格式的解析。

假如你有一个实体类,如下:

@Data

public class KingsBankCard {

/**

* 卡号

*/

private String cardNo;

/**

* 密码

*/

private String password;

}

你需要将他写入rap2的响应内容参数,那么你就需要手动将cardNo和password字段的注释即rap2响应内容的简介拷贝进去,本工具将解决这一部分的难题,实现简单配置自动导入。

下载地址:https://gitee.com/mirrors/kings-rap2-generator

3、SApidoc(API 文档生成框架)

SApidoc 是 Spring Boot 项目 API 文档的自动生成框架。

注明

以上就是程序文档工具Swagger-more、kings-rap2-generator、SApidoc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章