在线API文档生成工具推荐-统软云专业App开发平台

在WEB项目中经常使用一些界面管理工具，并总结了一些有用的在线文档生成工具。每个工具都有不同的特点，但通常满足以下要求：1.开源2.可以实时生成在线文档3.支持全文搜索4.支持在线调试5.界面美观

共找到7个文档生成工具，如1.gitbook2.smartdoc3.redoc4.knife4j5.yapi6.apidoc7.showdoc所示

以下是：

1、 Gitbook（Gitbook）

Github地址：

星：22.9k

开发语言：javascript

用户：500000+

推荐指数：★★★

地址示例：

GitBook是一个文档编辑工具。其功能类似于金山WPS中的Word或Microsoft Office中的Word。它可以用于编写文档、创建表格、插入图片和生成pdf。当然，上述WPS和Office功能可能更好，但gitBook具有最强大的功能：它可以用文档构建一个网站，让更多人了解你的书。此外，最重要的是它支持Git，这意味着它是一个分布式文档编辑工具。您可以随时随地编写文档，也可以多人一起编写文档。即使多个人在同一页上编写文档，它也可以记录每个人的内容，告诉你他们之间的差异，并记录你的更改。您可以查看每个书写记录并进行更改。即使您删除了文档，也可以找到它！这就是git的力量！

优点：它使用非常简单，支持全文搜索，可以与git完美集成，在代码中没有嵌入性，并且支持以markdown格式编写文档。

缺点：需要单独维护文档项。如果修改了界面，则需要手动修改单据项。否则，界面可能与文档不一致。此外，不支持联机调试。

个人建议：如果外部接口很少，或者在编写后不会频繁更改，可以使用此选项。

2、 智能文档

Gitee地址：

星：758

开发语言：html、javascript

用户：小米、科大讯飞、1 Plus

推荐指数：★★★★

地址示例：

Smart doc是一个javarestful api文档生成工具。智能文档颠覆了传统的实现方法，如swagger，它使用注释入侵来生成文档。智能文档完全基于接口源代码分析生成接口文档，完全实现了零注释入侵。您可以通过编写java标准注释来获得标准markdown接口文档。

优点：基于界面源代码分析生成界面文档，零注释入侵，支持html、pdf和markdown格式的文件导出。

缺点：需要引入额外的jar包，不支持在线调试

个人建议：如果您想实时生成文档，但不想在使用swagger时添加一些附加注释，例如@Api、@ApiModel和其他注释，可以使用此选项。

3、 Redoc公司

Github地址：

星：10.7K

开发语言：typescript、javascript

用户：docker、重做

推荐指数：★★★☆

地址示例：

Redoc自称是最好的在线文档工具。它支持swagger接口数据，提供多种生成文档的方法，并且非常易于部署。使用redoc-cli，您可以将文档绑定到零依赖性HTML文件中。响应式三面板设计具有菜单/滚动同步功能。

优点：生成文档非常方便。三面板设计

缺点：不支持中文搜索，分为普通版和付费版。正常版本不支持联机调试。此外，我个人觉得UI交互并不适合大多数国内程序员的操作习惯。

个人建议：如果你想快速构建一个基于swagger的文档，并且不需要在线调试，你可以使用这个。

4、 刀4j

收件人地址：

星形：3k

开发语言：java、javascript

推荐指数：★★★★

Knife4j是Java MVC框架与Swagger集成以生成Api文档的增强解决方案。它的前身是swagger bootstrap ui。它被命名为kni4j，因为它希望它能像匕首一样小、轻、有力。

优点：基于swagger生成实时在线文档，支持在线调试、全局参数、国际化、访问控制等，功能非常强大。

缺点：界面有点难看，需要依赖额外的jar包

个人建议：如果公司对UI的要求不高，您可以使用此文档生成工具。比较功能相对强大。

5.