几个在线文档接口生成工具

好用的在线文档生成工具，具体要求如下：

1.能够实时生成在线文档 2.支持全文搜索 3.支持在线调试功能 4.界面美观

说实话，这个需求看起来简单，但是实际上一点的都不简单。

我花了几天时间到处百度，谷歌，技术博客和论坛查资料，先后调研了如下文档生成工具：一、gitbook 开发语言：javascript 用户：50万+ 示例地址：https://www.servicemesher.com/envoy/intro/arch_overview/dynamic_configuration.html

GitBook是一款文档编辑工具。它的功能类似金山WPS中的Word或者微软Office中的Word的文档编辑工具。它可以用来写文档、建表格、插图片、生成pdf。当然，以上的功能WPS、Office可能做得更好，但是，GitBook还有更最强大的功能：它可以用文档建立一个网站，让更多人了解你写的书，另外，最最核心的是，他支持Git，也就意味着，它是一个分布式的文档编辑工具。你可以随时随地来编写你的文档，也可以多人共同编写文档，哪怕多人编写同一页文档，它也能记录每个人的内容，然后告诉你他们之间的区别，也能记录你的每一次改动，你可以查看每一次的书写记录和变化，哪怕你将文档都删除了，它也能找回来！这就是它继承Git后的厉害之处！

优点：使用起来非常简单，支持全文搜索，可以跟git完美集成，对代码无任何嵌入性，支持markdown格式的文档编写。

缺点：需要单独维护一个文档项目，如果接口修改了，需要手动去修改这个文档项目，不然可能会出现接口和文档不一致的情况。并且，不支持在线调试功能。

个人建议：如果对外的接口比较少，或者编写之后不会经常变动可以用这个。二、smartdoc 用户：小米、科大讯飞、1加示例地址：https://gitee.com/smart-doc-team/smart-doc/wikis/文档效果图?sort_id=1652819

smart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，只需要按照java标准注释的写就能得到一个标准的markdown接口文档。

优点：基于接口源码分析生成接口文档，零注解侵入，支持html、pdf、markdown格式的文件导出。

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

个人建议：如果实时生成文档，但是又不想打一些额外的注解，比如：使用swagger时需要打上@Api、@ApiModel等注解，就可以使用这个。三、redoc 用户：docker、redocly 示例地址：https://docs.docker.com/engine/api/v1.40/

redoc自己号称是一个最好的在线文档工具。它支持swagger接口数据，提供了多种生成文档的方式，非常容易部署。使用redoc-cli能够将您的文档捆绑到零依赖的 HTML文件中，响应式三面板设计，具有菜单/滚动同步。

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

缺点：不支持中文搜索，分为：普通版本和付费版本，普通版本不支持在线调试。另外UI交互个人感觉不适合国内大多数程序员的操作习惯。

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

四、knife4j 用户：未知示例地址：http://swagger-bootstrap-ui.xiaominfo.com/doc.html

knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍。

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

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

个人建议：如果公司对ui要求不太高，可以使用这个文档生成工具，比较功能还是比较强大的。

五、Eolinker 用户：360，中化，广联达，统一，柏涛示例地址：https://www.eolinker.com/

Eolinker是国内团队自主研发的，主要支持以下功能： • 可视化接口管理 • 数据mock • 自动化接口测试 • 数据导入（各种，包括swagger、har、postman、json、命令行） • 权限管理 • 支持本地化部署 • 支持插件 • 支持二次开发优点：功能非常强大，支持权限管理、在线调试、接口自动化测试、插件开发等，拓展性也很好。

缺点：是Saas管理工具，没有源码。个人建议：如果需求比较复杂，这个在线文档工具还是非常好用的，笔者在这里强烈推荐一下。

几个在线文档接口生成工具相关推荐

vvv在线文档导出工具_一款真正实时的在线文档协作编辑工具，多人可同时对一份文件修改...
etherpad-lite 一个非常实时的网络协作文字处理器 Etherpad是一款真正实时的协作编辑器,可扩展到数千个同步实时用户. 与所有其他协作工具不同,Etherpad提供完全保真的数据导出和 ...
Java实现生成数据库表结构文档（生成工具screw的使用）
目录一.screw介绍 1.简介 2.特点 3.文档格式二.生成方式 2.1 方式1:使用 Java 代码 2.1.1 引入依赖 2.1.2 编写代码 2.1.3 测试 2.2 方式2:使用 Sp ...
python docx 合并文档图片_MBT文档模型化生成工具——30倍效率文档撰写工程化方法...
MBT(A model based document builder)文档模型化生成工具用户手册--30倍效率文档撰写工程化方法 1 简介在软件工程领域,工程文档通常主要包括实施方案.需求分析.软件 ...
java如何生成api文档_api文档自动生成工具
java开发,根据代码自动生成api接口文档工具,支持RESTful风格,今天我们来学一下api-doc的生成预览在线预览地址开发原理这个工具是一个典型的前后端分离开发的项目,想了解前后端分离 ...
Java api文档自动生成工具smartdoc+torna
首先,一般做java服务端都用过postman,并且都写过前端调用的api文档接口,并且也用过市面上的一些工具. API自文档动生成,能够省去了写文档的时间. 当然,当前也会有很多类似的开源工具,我们 ...
接口文档如何编写，接口文档快速生成工具
正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我总结下自己看到的优秀接口文档. 一.背景介绍接口:API API(Applic ...
HTML免费在线文档批量翻译工具
免费在线文档翻译不同于一般的段落文章复制粘贴在线翻译,免费在线文档翻译支持我们将我们的不同格式的整篇文档进行翻译,还可以将多篇文档放入我们的一个文件夹中,对这个文件夹进行批量翻译,适用于需要大量进行批 ...
Spring Boot集成Restful Api在线文档接口调试工具 Swagger
文章目录一.Swagger简介 Swagger有什么用? 二.环境准备三.构建Spring Boot工程四.引入Swagger依赖五.编写一个Test控制器六.配置Swagger 七.最终测 ...
docsify神奇的文档网站生成工具
原文链接个人博客-欢迎访问 docsify 是一个动态生成文档网站的工具.不同于 GitBook.Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行. 这将 ...

几个在线文档接口生成工具

几个在线文档接口生成工具相关推荐

最新文章

热门文章