[量化投资接口]接口文档生成工具_股票自动交易程序化数据接口

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

必须是开源的

能够实时生成在线文档

支持全文搜索

支持在线调试功能

界面优美

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

我花了几天时间到处百度，谷歌，技术博客和论坛查资料，先后调研了如下文档生成工具：

gitbook

开源协议：Apache-0License

开发语言：javascript

用户：50万+

示例地址：https://www.servicemesher.com/envoy/intro/arch_overview/dynamic_configuratiohtml

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

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

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

个人建议：如果对外的量化投资接口,接口比较少，或者编写之后不会经常变动可以用这个。

smartdoc

开源协议：Apache-0License

开发语言：html、javascript

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

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

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

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

个人建议：如果实时生成文档，但是又不想打一些额外的注解，比如：使用swagger时需要打上@Api、@ApiModel等注解，就可以使用这个。

redoc

开源协议：MITLicense

开发语言：typescript、javascript

用户：docker、redocly