程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API介绍

以下为你介绍的程序文档工具都可用在Linux系统上:smart-doc(Java Restful API 文档生成工具)、swagger-mg-ui(Swagger UI 的前端实现)、zdir(基于 PHP 的目录索引系统)、Regan API(基于注释自动生成 API 文档)。

1、smart-doc(Java Restful API 文档生成工具)

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc、Postman json文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱smart-doc吧!

功能特性:

零注解、零学习成本、只需要写标准java注释。

基于源代码接口定义自动推导,强大的返回结构推导。

支持Spring MVC,Spring Boot、Spring Boot Web Flux(controller书写方式)。

支持Callable、Future、CompletableFuture等异步接口返回的推导。

支持JavaBean上的JSR303参数校验规范。

对json请求参数的接口能够自动生成模拟json参数。

对一些常用字段定义能够生成有效的模拟值。

支持生成json返回值示例。

支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。

支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman json。

轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。

开放文档数据,可自由实现接入文档管理系统。

支持生成Postman json数据一键到入到Postman测试接口,参数值默认帮你填好。

从1.8.0版本全面支持json和表单请求解析。

一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。

支持导出错误码和定义在代码中的各种枚举字典码到接口文档。

知名用户:

一加【oneplus】、科大讯飞、小米。

给使用者的建议:

smart-doc虽然可以关闭注解检测,好的规范更容易让项目变得更容易维护。

smart-doc的出发的目标不是仅仅为书写接口的开发人员自己测试接口服务的,而是希望导出的文档能够用极少的变更就能做接口服务对接文档。

smart-doc主要目的是为了减少接口文档书写和造测试模拟数据。

smart-doc目前得到了很多使用者的支持,包括一些知名的公司也有研发团队在使用,相信我们能做好一款文档生成工具。

smart-doc具备完备的文档,用户在使用过程中能够快速的解决问题。

Markdown工具推荐:

smart-doc目前能够支持将文档合并到一个markdown文件,因此你可以使用Typora工具将markdown转换成pdf、word或者是html文档。

入门:

# git clone https://gitee.com/sunyurepository/api-doc-test.git

你可以启动这个Spring Boot的项目,然后访问http://localhost:8080/doc/api.html来浏览smart-doc生成的接口文档。

下载地址:https://gitee.com/sunyurepository/smart-doc

2、swagger-mg-ui(Swagger UI 的前端实现)

swagger-mg-ui是swagger-ui的一个前端实现,一个从0开始写的项目,使用简单、解析速度快、走心的设计,支持多项目同时展示,多种文档目录的展示方案,多种自定义配置,满足各种使用习惯,使用中你有任何的意见和建议都可到项目地址处反馈!

看了很多现有的实现,没找到特别适合我这个强迫症的,于是动手写了此项目,在我们几个后端项目中已集成且持续优化更新中,在实践中成长,所以做的都是特别急切的、实用的、易用的功能!

demo代码地址:https://gitee.com/zyplayer/swagger-mg-ui-demo

已上传至中央仓库,使用方法:

<!-- https://mvnrepository.com/artifact/com.zyplayer/swagger-mg-ui -->

<dependency>

<groupId>com.zyplayer</groupId>

<artifactId>swagger-mg-ui</artifactId>

<version>1.0.1</version>

</dependency>

功能细节:

支持添加多个文档,同时展示。

左侧的侧边栏支持左右拖动改变大小。

优化各种细节,做到能不展示就不展示。

更多细节等你发现。

相关截图:

程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API介绍

程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API介绍

程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API介绍

3、zdir(基于 PHP 的目录索引系统)

程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API介绍

zdir-使用PHP开发的目录列表程序。

使用方法:

下载源码放到站点根目录。

修改config.php设置自己的网站标题/关键词/描述。

如果需要排除某个目录,继续修改config.php。

主要功能:

目录浏览、MarkDown文件预览、CSS/JavaScript一键复制、文件hash、图片预览、文件索引。

注意事项:

不要使用中文命名目录/文件,否则可能发生不可预料的错误。

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

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

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

Regan API 基础项目基于 jfinal 开发,前端基于飞冰开发。如果别的 项目需要引用只需要加入src下api包下的文件,以及webapp下api目录里的页面。

程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API介绍

程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API介绍

启动:

执行 ApiConfig 下main方法即可。

注明

以上就是程序文档工具smart-doc、swagger-mg-ui、zdir、Regan API的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章