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

告别手写 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

移动周报:夫妻档闯江湖 事业爱情双丰收 当服务器遇见锤子:第六届AWS全球创业大赛落幕 C# DataTable 和List之间相互转换的方法 iPad如何在三年内改变世界 划时代的成果:新DNA存储技术 轻而易举装下世界 谷歌产品设计:Larry Page的魅力革命 开源移动统计工具Countly更新 支持Unity 3D DailyCost传奇设计师访谈,彰显HTML5移动应用优势 如何成为一名架构师? Apache Hadoop集群的安全性架构 Wood Camera开发者访谈:我们如何冲到榜首的 代码审查:程序员内炼之道 Twitter Q1推广告API 收入剑指10亿 Dell:在OpenStack成熟后才会推出服务 一个开源工作者对开源与赚钱的一些想法 宏碁:Windows8仍不成功 Chrome表现令人意外 雅虎发布Q4财报 净利润同比下滑8% 游戏机禁售令起风波,索尼任天堂股价大涨 国外开发者吐槽Facebook Android设计一例 Rovio转向发行业务 将发布新作Tiny Thief 上山下海 “硬汉”服务器无所不能 访金山云CTO杨刚:开源改进PK自主研发,技术驱动前行 苹果涉及色情问题,且进一步恶化 开源产品系列:面向组件的Web框架tapestry 360指责百度窃取用户信息 公布美杜莎插件技术分析 苹果正式发布iOS 6.1 最快本周日即可越狱 苹果高管:运行iOS 6的设备达3亿 Chrome OS 黑客大赛总奖金为314.159万美元 微软雷德蒙研究院副总裁:从计算研究到惊人发明 还驾驭不了4核? 别人已模拟出百万核心上的并行 RIM将网络直播BlackBerry 10发布会 如何將字符串以十六進制的形式顯示在Edit中 关于SOCK5代理服务器的第二次协商问题? 为什么oracle的sql语句的表名必须加“”??? 谁能解决工具条中的一问题?50分相送 ##### 100分求教:如何实现框架集下页面的定向输出?##### 菜单菜单!!! 如何用Schema验证XML文档 JSP中jsp文件和bean的class文件的相对位置是怎么样啊? excel中的两个问题:1、如何关闭userForm1窗口?2、如何在打开userForm1窗口时使主窗口最小化? Dll函数问题 咋判断用户点的四点能围成一个四边形? 网站中的某一页嵌入VB的AtiveX 控件,客户端能访问网站,但不能打开AtiveX控件。。。高分 请问怎么把 string 型转换成 System.Data.SqlDbType 型? 机器无法启动 主板有问题吗 高分请教 创建不了C#Web项目,急!!!(刚学C#) [求助] 用fopen函数读不出URL文件? 怎么判断listview是否有一个item被选中? 请说一下硬盘容量和内存容量的关系! ▄▅▆▇█ 水园的大背景离不开吵架 █▇▆▅▄ 请教mm有个问题! linux下的编程问题 以Oracle为例说明如何通过ODBC将数据库中的指定表导出到MDB数据库。(原创) 关于一种特殊按钮 SQL语句小问题!!在线等待! 想学ColdFusion 请看我的转载的贴子 Troj_Hacline.A是什么病毒? 关于XML的问题,150分赠送,急 dll问题。很简单。 感慨!!!(潜水一年,吐个泡,顺便发表一点意见) 帮个忙 怎么在Installshield中创建对话框,并操作ACCESS数据库? 连续给分:邮件服务器防病毒问题! 我想编译一个像API一样的dll 启动rose就出错,高手来看,100分 关于打印的一个问题 急!!!请提供一段设置Session的全部代码,谢谢!! 请问,从第二帧开始播放的代码的什么??? 老师要求编写五子棋的程序可是我实在想不出该怎么设定估价函数啊帮帮忙啊? 感觉压力比较大,活不下去,想跳楼自杀的进来侃侃 一个关于php提交表单的问题。 各位大侠,要命问题! 怎么在Installshield中创建对话框,并操作ACCESS数据库? win2000server的管理员密码让人改了,怎么办呀! 太气愤了,帮帮我? 用BDE连接MS SQL SERVER,为什么运行后出现未知用户名或密码的错误? datagrid中能不能进行统计 如何编写“outlook”风格的界面 如何实现flash截图?我研究了好久也不明白,希高手指点!(在线等待) 程序调用的DLL 在delphi中,用ADO如何实现将SQL中多表导出到一个Access中? 热力学上的二级相变是什么? 1.管理原理的主要特征为____、____、____、____.2.管理和战略,____告诉我们怎样"做正确的事",____在 一道比大小的题,答对了加分,1小时15分大于还是小于还是等于1.15小时? 陨石 爆炸会引发黑洞不? 一、填空题 1.管理原理的主要特征为____、____、____、____. 2.管理和战略,____告诉我们怎样"做正确的 分数比大小,填大于小于或等于,题在下面32/24O21/9 15/12O24/16 51/17O100/25 O里面填大于小于或等于 宇宙里,被卷入黑洞后,会去哪里?我觉得不应该消失的无影无踪,因为你可以自己想想,一个物体不会忽然没有这个物质了吧?我觉得被卷入黑洞后,是不是带物体去了另外一个空间?(不是宇宙里 管理原理是具有普遍指导意义的基本规律,它的主要特征有? 几道关于一次函数的题目;大于或等于初2者进①下列是关X与Y变量与的关系式:1;Y=X 2;Y*Y=X 3;2X*X-Y=0 4;2X-Y*Y=0其中是的函数有_______.(填序号)②已知关于X的方程AX-5=7的解为X=1,则一次函数Y=AX- 我国武装力量是由哪几部分组成的?分别说明,具体点, 自动控制原理的主要特征是什么 最近比较火的事情是什么?最近娱乐圈有什么比较火的事情吗?还不是特别清楚. 果园今年收苹果450千克,收的梨比苹果的4倍少168千克,果园今年收梨多少千克? 岛津义弘怎么死的 现在全世界最关注的事情是什么 人非生而知之者 孰能无惑的而 鬼石曼子是谁? 世界上所有注入印度洋的河流有哪些主要的河流 4条就行了 2012光子带 什么样子的人会死去 岛津公司与战国时的岛津义弘等有何关系?家徽都一样. 用长,宽,高分别是3厘米,1厘米,1厘米的小木条拼成一个正方体,至少需要这样的小木条()条 沉重的反义词时是什么 2012进入光子带时会怎样,要全一点的,进入之后呢?什么人会死 丑鬼只是一种外号而已吗?很多人都说我不丑``但是又有很多人老是叫我丑鬼!难道只是外号而已吗?还是为了不想伤我自尊而说的? 沉重的反义词是什么? 急! 2012会进入光子带吗?我们会死吗?我才14岁啊 不要复制 看多了我艹 真死假死 不能开玩笑的! 《春望》中表达诗人对国土沦陷触目伤情的诗句是? 沉重-( )[反义词] 想自己在家里用电灯泡孵化小鸡,我找到个资料,不到能不能孵,有经验的人提提意见.准备个箱子要孵多一些箱子就大些,在底下垫棉花,把鸡蛋放在上面,拿一个60瓦的灯泡,放在比鸡蛋高一寸的地 国土半壁沦陷,民族存亡危难怎么翻译成英文呢? 如果南极的企鹅养在我们居住的地方,要注意什么问题?要 注意的是温度. 人非生而知之者,孰能无惑告诉我们一个什么道理 1、我的名字叫勾践,士兵被杀,国土沦陷,堂堂国王当马夫,每天卧薪尝胆.我的名字叫张海迪,每天只能坐轮椅,高位截唐虽然苦,自强不息超过你.我的名字叫桑兰,本是优秀运动员,一朝不慎身瘫痪, MT是什么意思 用19这个数字和创造结合起来设计一个标志, 英语翻译最好能体现出"本就"这两个字(我用google翻译本就为this to,用这个怎么造句) Western杂交就是western blot 莫, 如图,直线CD,EF相交于点O,OA⊥OB,OF平分∠AOD,∠BOE=2∠BOC,求∠BOC的度数如题 沦陷区比实际控制国土还大的国家有哪些?东亚的这几个不用说. Western杂交中,为何要引入二抗?为何不在一抗上直接加上放射性同位素或者GFP? 含反义词的成语写出五个 战国名将岛津义弘名气为什么比将他打的落花流水的陈璘大有此看来 前田和真田和伊达和柴田等都是垃圾 western杂交可否用于检测酵母菌基因组特征 谁能打出下面这个符号 急用 已有林权证,是否还需办理土地使用证?某部队与村委会购买林地,已办理林权证,期限至2078年.现某部队又申请办理土地使用证,是否能给予办理? 要是住在南极的企鹅生活在热带会怎么样 人非生而知之者 孰能无惑的意思 历史上的武则天到底是什么样的人? 南极的企鹅可以在北极生活吗? 怎样防止小鸟吃田地里的庄家 武则天有喜欢的女人吗?很多皇帝不仅有女宠也有男宠,武则天有女宠或者是比较喜欢的女人吗?拜托三楼的,你们不要乱讲可以么,贾静雯是饰演武则天的演员的名字啦.你们可以给点具体的确切 如何去掉质谱中的杂峰? 用LCMS测试样品时质谱中总是存在143的峰,更换流动相后仍有此问题,请问如何解决 诱使1998年嫩江和松花江大洪涝灾害的根本原因是什么 武则天是个怎么样的人? 为什么热力学基本关系式不适用与相变? 人非生而知之者,孰能无惑.快 武则天是哪个皇帝的女人啊? 请问为什么说热力学公式一般只适用于恒组成的均相封闭体系?比如等压反应热等于焓的改变值的公式适用条件是封闭体系等压的物理化学变化过程就可以了,那和上面的说法又不一样了…… 测泥浆性能个种仪器的使用方法 求赞美家乡的作文!家乡比较有名的是蔬菜,是著名蔬菜之乡家乡变化比较大 着重写家乡的道路,城市建设,晚间景色(喷泉,霓虹灯等),家乡的弥河水 松下半导体部门将大幅裁员部分港生在内地\"水土不服\" 投诉审计署回应“与纪委合署办公”:需从长“清风”生活用纸全国巡展首站启动星罗棋布 星巴克位置百度地图全知道工信部:婴幼儿乳粉兼并重组方案已报国长沙警方称新快报记者被拘案正按法律程原杭州市委书记黄坤明任中宣部副部长(职场\"咸鱼族\":得过且过不翻身 中国工商登记制度改革将宽进与严管并进巴基斯坦总理会晤奥巴马 当面敦促叫停美14岁中学生被控谋杀女教师 48小美媒指俄文化中心在美招募间谍 俄官方美国警察将玩具枪看成突击步枪 误杀1埃及教堂婚礼遭枪击多人伤亡 过渡政权因大量毒蜘蛛入侵 英国一中学校园被迫评论:拒任“非常任理事国”沙特给美脸被“假寡妇”咬会丧命 英国中学因毒蜘美媒:中东局势将沙特推向十字路口 改韩媒:韩国越冬泡菜有望入选联合国非物澳大利亚蓝山险招治山火 当地居民获准近百台挖掘机拆除南昌永和门立交桥古人受到什么影响才创作出敦煌莫高窟中安理会声明谴责朝鲜发射导弹 称将采取加油,为实现中国梦增添强大精神力量述评:中欧班列助推丝路经贸驶入快车道展望G20杭州峰会:专家学者眼中的主越南同志辛苦了!为了嘬口烟,牺牲太大宗庆后:中国人比较难管,因为聪明都想对贿选窝案就该绝对“零容忍”价格涨、产量降,长沟果农难见笑脸湖南慈利县中医院副院长李国平被调查(周口教育局官员喝茅台后互殴 局长等多伊能静公开肚子伤口及微信截图 反击美重庆綦江:一碗“脱贫”羊肉汤立足台商 福建漳州探索开放型经济新体湖南汝城县委常委、常务副县长陈向华被濮阳市台前县产业集聚区党工委书记张峰第五届全国少数民族文艺会演展现多彩中独家暖新闻:人狗情未了——中英联手千万钢:中小城市应成为创新要素主要聚集“海峡号”年检停航 台商指“影响大”
备案号:鲁ICP备13029499号-2 说三道四 www.s3d4.cn 说三道四技术文摘