说三道四技术文摘-感悟人生的经典句子
说三道四 > 文档快照

告别手写 API文档生成工具推荐

HTML文档下载 WORD文档下载 PDF文档下载
随着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

Android 4.3正式发布:四大新功能一览 史玉柱的创业经验谈 3G门户和GO桌面:海外推广的生意经 系统级编程语言性能大PK D语言成首选 解读Facebook第二季度财报 移动业务风生水起 如何避免失败,像Google一样玩转大数据 首届游戏运营技术论坛隆重开幕,共论大数据时代的游戏运营之道 OpenStack Swift遇到了Erasure Code 微软Win7 IE11开发者预览版发布 开始改进开发工具讨好开发者 个性化推荐服务商百分点宣布B轮融资1000万美金 全球著名互联网企业背后的开源力量 基础设施对决Facebook vs. Google:差距绝不是一点点 Amazon Q2财报同比转亏,但AWS反其道而行:高歌猛进! 开拓海外市场的两年:海外上线小技巧 SDCC 2013首批讲师名单出炉 一线工程师唱主角 [开源推荐] 跨平台的.NET运行环境 Mono 3.2发布 Heroku发布API平台Beta版 采用OAuth2.0安全授权 大数据时代:移动数据能为我们带来什么? iOS开发经验谈:如何提高应用开发效率? 贝索斯:你否定亚马逊的现在 我决定亚马逊的未来 谷歌新产品Chromecast:一夜之间价格从35美元飙至100美元 移动周报:苹果5周年限免神作,BADLAND开发者访谈 开源平台Cloud Foundry获IBM和百度支持,步入高速发展的“黄金期” GDK仍未发布 谷歌鼓励Glass开发者可提前用Android SDK开发 Adobe发布PhoneGap 3.0 支持命令行工具 初级vs.高级开发者 哪个性价比更高? 一周观察:Cloud Foundry生态圈渐成型 数据分析中的10个注意点,让你更了解用户体验、行为及需求 压不垮就奋行!Dropbox Datastore API给初创NimbusBase带来的启示 史上14大最具创新意义的科技发明 亚马逊应用商店:给应用开发者一个国际舞台 请问各位高手改变字段类型和向一个已存在的表添加新字段的SQl怎么写? 请问在XML规范里TR是什么的缩写? 关于COM中“聚合”的问题,那位大侠给小第指点迷津,多谢多谢! 呵呵!! CSDN 茶馆 再次开张!!!!(东北分店)欢迎光临 那有pdf版的经典的英文计算机书下载。 来指教一下http://www.csdn.net/expert/topic/383/383603.shtm 发送Microsoft.XMLHTTP怎样获得验证 ldap的问题,大家都来看那, 【怎样在韩文版的windows中调出输入法?】 :)java参考书指点................. 怎样获得Microsoft.XMLHTTP请求验证??? 关于asp.net的web控件的响应事件问题! DOS程序后台运行问题? 高手请指教->多个Form间怎么互通消息? 菜问题....D3D的 谁知道怎么做oicq,分全部归他。 各位兄台:如何激活一个窗口! 我发送Microsoft.XMLHTTP怎样获得验证??? 高分相送:有没有能察看一个dll文件中包含哪些函数的工具??????? help!!!! 怎样发送Microsoft.XMLHTTP获得验证???????? 请问,ASP中,能使用类似VB中的“On Error GoTo XXXX”这样的语句吗? foxpro怎样倒入sql server? 我现在有foxpro的dbf文件?应该怎样做? 多谢 mediaplayer的问题。 告诉我tostring 函数什么用途我们感到阿!谢谢了一个初学者! 请问VB6如何才能认到access2000的数据库文件? 关于对象序列化问题 怎样让返回值为自定义结构? 怎么在对话框上面话线? 请解释一下跃点数 小问题一个,但是需要高手................. 我想把公司的网站改放到公司,该怎么办? ——如需要还有很多分送 请帮忙,我自己觉得问题很难(特急)!!!!!!!!!!!!!!!!!!!! 明天我哥结婚,我很开心啊!!! 我想把公司的网站改放到公司,该怎么办? ——如需要还有很多分送 关于存储过程和触发器的问题?(高分求助) WIN2000机器上ADSL,另一台linux下如何做ADSL的代理让局域网中机器上网! 为什么新生成一个session对象后,jsp page中的scope=session的bean会不正常? ★★oracle中ora-04031错误 请问:在安装MSSQL2000 时(因为公司的电脑是对等网的原因)我装完后出现以下错误: 我应该去东软吗? 请您帮我诊断一下! 如何共享已打开的设备 rs.open sql,conn,3,2参数含义? 我应该去东软吗?? 求救~~~~安装完WINXP,进入系统前会出现错误窗 怎么现在没法用search了? 一个菜鸟的问题,关于事件的加载 求救~~~安装完WINXP,进入系统前会出现错误窗 关于速度,效率,VB IIS ASP COM高手请进 王爷和皇上的妃子 王爷是皇上的弟弟,嫔妃叫他什么?(不包括皇后) 王爷叫嫔妃什么? 中秋节写月亮的作文怎么写 写《给妈妈的爱》一篇作文 中秋节作文 下雨看不到月亮 所以别写赏月 500字 别写太幼稚看不到月亮 死也看不到月亮好吗 就是没月亮 然后我初一. 父爱的作文300 妈妈的爱500字作文怎么写 八十天环游地球读后感400字以上 谁有初中500字的作文,+上50字的读后感.我球球你们了~ 读后感100字 两篇 八十天环游地球读后感600字 求《朝花夕拾》的十篇文章的中心思想(100字)和读后感(50字)读后感(50字) 英语:“平安夜快乐” 怎么拼写?merry christmas eve?orhappy christmas eve? 八十天环游地球读后感350字.有一个感想(举例说明.350越精确越好,别多出50字) 描写中秋月亮的作文 那一刻我感到温暖 500字作文KUAI 作文 中秋节500字没月亮 《八十天环游地球》读后感1000字至2000字 用英文介绍平安夜的由来 没有月亮的中秋节作文300字,快,不要乱说!急记急亟亟记鸡鸡鸡鸡鸡鸡鸡. 八十天环游地球读后感100----200字左右就行,不要太多.说一下文中主人公就行. 写中秋或月的美文 中秋节的作文600 字.. 要没有月亮 长公主和皇贵妃哪个大 平安夜的英文怎么说 皇上怎么向他姐姐请安? 有关月亮的作文300字1111 描写中秋月亮的文章字少一点,急用.谢 皇上怎么给太后请安请问各位有知识的人谁能告诉我皇上是怎么给太后请安的 父爱作文600字求一个题材新的好文章(初中的)题材要多,不知道的别瞎打! 谁能用英文介绍下平安夜的由来(中英对照的) 跨越百年的美丽“这项伟大自然发现”是指() 关于父爱的600字作文 关于父爱的作文400字题材要真实,不要故事性的,要记叙文,找别人的也行,不过题材合理.字少点.好了+100 跨越百年的美丽中“这项伟大自然发现”指的是 父爱的作文600字初中,多些描写,比如心理描写、动作描写.要有真情实感,一定要真实! 写父爱或者母爱的作文400字 有关场面描写的作文 昆虫记读后感50----100字 皇后用向皇帝姑姑(大长公主)行礼么 皇后是她的侄媳妇 太长公主是皇后的姑婆婆 18课 《跨越百年的美丽》小练笔“化验室只是一个废弃的破棚子,玛丽终日在烟熏火燎中搅拌着锅里的矿渣.他衣裙上,双手上,留下了酸碱的点点烧伤.”居里夫妇在这样恶劣的环境中坚持实验, 求100字昆虫记的读后感, 皇帝的姐姐和妹妹的辈份分别比除皇后外的妃子高还是低?用的向她们行礼吗?长公主的辈分比谁高和比谁低?请给准确的答案我好吗? 六年级下册的18课《跨越百年的美丽》的作业本上的小练笔怎么写? 昆虫记读后感100字 以“教育与未来”为题作文800字左右 (《跨越百年的美丽》)小练笔“化验室”只是一个破棚子,玛丽终日在烟熏火燎中搅拌这锅里的矿渣,她衣服上、双手上,留下了酸碱的烧痕.居里夫妇在这样恶劣的环境中坚持实验,要面对困 昆虫记读后感 100字 红色影片观后感 400字(不能写亮剑) 今天上午就要 谁写的好+100分 小练笔《跨越百年的美丽》跨越百年的美丽 前提:居里夫妇在这样恶劣的环境下要面对多少困难和挫折啊!请你想象其中一个场景,并把它写下了差不多200字左右好的我加分 太子见到长公主要行礼吗?该说什么? 跪求300字读后感3篇 好的+100分 有关场景描写的作文 《中秋月圆时》作文, 平安夜的英语怎么拼写. 给皇帝请安怎么说 昆虫记 读后感 只要100字就够了 但是要五篇啊~急啊~~~~~~一篇也可以啊~帮帮忙啊~ 平安夜 英文 古代王妃在新婚的第二天要向皇上请安,当皇上、皇后、太后同在时,该先向谁请安?太后是千岁千岁千千岁?或者是别的?因为是小说需要,仅虚构,不用分哪个朝代,一般是怎样的? 关于父爱、母爱的作文(300多字)最好不要太深奥, 父爱500字作文
备案号:鲁ICP备13029499号-2 说三道四 www.s3d4.cn