告别手写 API文档生成工具推荐
2013-02-26 15:20
387 查看
摘要:随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工欲善其事必先利其器,本文分享8款非常好的API文档生成工具给大家。
随着API的发展以及需求的日益增加,对API文本文档的需求与随之而来。相信许多开发人员都遇到过编写API文档方面的问题及烦恼。
你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工欲善其事必先利其器,本文分享8款非常好的API文档生成工具给大家。
Web API文档工具列表
Swagger
——Swagger框架可以通过代码生成漂亮的在线API,甚至可以提供运行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。在线 Demo 。
I/O Docs
——I/O Docs是一个用于RESTful Web APIs的交互式文档系统。使用 JSON 模型根据资源、方法和参数定义 APIs。I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统。服务器端基于 Node.js 开发。在线Demo
apiary.io ——能够快速启动和运行文档,包括GitHub集成和I/O验证——更多建议可以前往Reddit查看上关于
Siyfion讨论。
Docco
——Docco是一个快速而随意、hundred-line-long、迭代程序风格的文档生成器。它会以HTML的方式显示评论和代码。
Dexy ——非常灵活的一款文档工具,支持任何语言编写的API。
Doxygen
——Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。 更多建议可以前往Reddi上查看
gkumar007相关讨论。
TurnAPI
——是一款付费的文档API工具。里面包含了智能WIKI编辑器、基于标准的Markdown、文档分支、还可以与Git、SVN、Mercurial同步、整洁的主题、友好的界面。
以上仅是作者在实践中发现的一些很好的工具,如果你有更好的建议或工具推荐,欢迎与我们分享。
来自:MATTSILVERMAN
随着API的发展以及需求的日益增加,对API文本文档的需求与随之而来。相信许多开发人员都遇到过编写API文档方面的问题及烦恼。
你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工欲善其事必先利其器,本文分享8款非常好的API文档生成工具给大家。
Web API文档工具列表
Swagger
——Swagger框架可以通过代码生成漂亮的在线API,甚至可以提供运行示例。支持Scala、Java、Javascript、Ruby、PHP甚至 Actionscript 3。在线 Demo 。
I/O Docs
——I/O Docs是一个用于RESTful Web APIs的交互式文档系统。使用 JSON 模型根据资源、方法和参数定义 APIs。I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统。服务器端基于 Node.js 开发。在线Demo
apiary.io ——能够快速启动和运行文档,包括GitHub集成和I/O验证——更多建议可以前往Reddit查看上关于
Siyfion讨论。
Docco
——Docco是一个快速而随意、hundred-line-long、迭代程序风格的文档生成器。它会以HTML的方式显示评论和代码。
Dexy ——非常灵活的一款文档工具,支持任何语言编写的API。
Doxygen
——Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。 更多建议可以前往Reddi上查看
gkumar007相关讨论。
TurnAPI
——是一款付费的文档API工具。里面包含了智能WIKI编辑器、基于标准的Markdown、文档分支、还可以与Git、SVN、Mercurial同步、整洁的主题、友好的界面。
以上仅是作者在实践中发现的一些很好的工具,如果你有更好的建议或工具推荐,欢迎与我们分享。
来自:MATTSILVERMAN
相关文章推荐
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- 告别手写 API文档生成工具推荐
- 【推荐】apidoc api文档生成工具的使用(mac)
- 推荐开源Api文档生成工具——Doxygen
- API文档生成工具推荐
- 工具:使用过的 API 文档生成工具
- RESTful API文档生成工具Wisdom RESTClient
- Flex AsDoc 文档API生成工具 可以生成和Adobe的ActionScript3帮助一样的文档 .
- 一个给 Java 程序员用的 Api 文档生成工具
- apidoc ----api文档生成工具的使用
- Api文档生成工具Swagger集成说明
- app后端开发二:API接口文档自动生成工具
- Javascript API文档生成工具YUIDoc的安装
- spring-restdocs利用测试用例生成API文档,AsciidocFX工具整合