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

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

TXT文件的读取-VB资料 VB 如何将dbgrid印出来 VB5.0调用Office97技巧 VB5如何把帮助文件加到设计的程序内? VB编程步步高-打印篇(二) VB编程的好帮手资源文件 VB的OPEN对话框控件图示功能扩充 VB通用数据表格输出程序的设计 VB网格中输入数据 VB应用程序中打印条形码的两种方法 VB与Windows资源管理器互拷文件 VB中DOS文件名与长文件名的转换 VB中的Unicode 和 Ansi 格式 VB中如何实现文本查找功能 VB中自制文件搜索器 Windows 初始化文件的修改 -VB资料 Word 97与WPS97的完美结合 -VB资料 比较两个文件-VB资料 采用递归算法删除带有多级子目录的目录-VB资料 菜单项的动态装入 -VB资料 处理加了密码的MDB文件-VB资料 VB创建临时文件 从公共对话框控件中提取多个文件名称 -VB资料 从全路径名中提取文件名 -VB资料 打印MsChart之类的控件 -VB资料 谈谈在VB6.0中如何使用资源文件进行编程 动画图像分解在VB动画设计中的应用 多重文档界面设计方法-VB资料 恢复回收站中的文件 -VB资料 VB获得位图文件的信息 VB获得文本框中光标所在行的内容 如果深愛的人要離開你,是變心還是死亡好一點?(讨论) 贴了二次为什么没有人指教? 戒水快两年了,如今回来看看,物不是人非啦 新手一问 关于datagrid 修改数据的问题,帮我看看,多谢 谁有这两本书,请帮忙发到我的邮箱里,100分相送 到底应该怎么办? 大家好,如何打开DLL文件? 建议成立一个程序员协会 关于IE中图片的保存 VB 语言支持问题 高分求李维《delphi5.xDELPHI5.X ADO/MTS/COM+高级程序设计》示例源码!!!! 请yangshu进来!给妳点分!!!倒分! 请教各位如何实现dbgrid中按住shift多选的问题? 请问把sql-server7中的数据文件copy出来行吗? 找不到类,请大家帮忙解决,谢谢 异常处理问题 怎样恢复被损坏的"本地用户和组" 小弟在线等待,一小问题,,大家来帮忙?? 求jsp树的原代码 最好是jsp+js+xml 执行效率要高。(从数据库中动态生成的)在线 关于多层结构中事务处理的问题. VB6.0升级到VB.NET的问题。 在ASP中使用ActiveX Control ADOTable表名如何在运行时“递进” 这样的待遇能招到人吗? 不好意思,问个技术问题。其他版实在没人气!只好来这问! 不爽,辞职,散分! 在线等待(100)往一个表的字段赋值,怎么不行啊! 急!在线等待! 如何把一个窗体内嵌到另外一个窗体的指定位置? 电源键设置问题 假设有一个变量CString str,调用str.GetBuffer(ncount);上面函数的参数应该为多少,才能取得缓冲中的全部字串值? 如何做局域网中的机子通讯 有关Enumerations的问题 请教英文语法检查的算法. 给些提示或参考资料好吗? 简单的关于对话框关闭的问题 关于新闻联播! 哪位有USB1或2.0的开发文档或相关资料? 关于JAVA的问题!请教高手~! 在delphi中用什么样的函数可以将十六进制数转换成十进制? 在MotoSDK3.1的moto388c上模拟正常,但换成T720出现严重问题。 开发“办公小助手”,我准备用VB开发,各位给点思路! 在2000下telnet到Solaris机器,c++编译的问题 droplist 女人啊女人 无法进入系统了,请大家帮我看看怎么回事。谢谢! 如何通过串口来读写数据? 急!想要得到机器安装的物理内存数量!最好还能得到锁定的内存数量! 如何在编辑框中输入完后,按回车鍵能响应到一个确定按钮 在delphi 程序中 如何控制 sql server 服务器的启动与关闭,也就是把 sql server 的服务停止,也就是屏幕右下角的 sql server 服务器中的 [欢迎讨论]J2EE之EJB与MySQL 如何办理易制毒证 嘉靖皇帝是如何死的? 新编初中版文言文助读的第32篇是什么?求原文! 如何有效易制毒胶囊类似事件发生 嘉靖是位有争议的皇帝吗?谈一谈他的功过是非.央视《大明王朝》,对他是褒还是贬? 朱厚熜是一个怎么样的皇帝,是一个好皇帝吗? 国家规定的易制毒化学试剂有哪些 在那里能看投明状朋友们告诉我一个地方,看看这个. 法华经主要讲的是什么 请问国家规定一类,二类,三类易制毒都包括那些品种请提供具体品种 就是说一个明星要连投, 法华经总共有几部我买了法华经7部,不知道有没有买齐, 太阳是月球的许多倍The sun is __ __ __ __of the moon在横线中填单词 臭味相投的投是什么意思 吃了一块烧焦的肉怎么办 W______ is bigger ,the sun or the moon?这道题目是根据句子或对话意思及首字母提示补全所缺单词 神将世界陈宫怎么打 一道化学离子推断题在一种酸性溶液中可能存在NO-、I-、Cl-、Fe3+中的一种或几种离子.向该溶液中加入溴水,单质溴被还原.由此可以推断该溶液中:含有什么?不含什么?不能确定什么?请给出具 Which is larger,the sun________the moon?A.so B.but C.and D.or 神将世界陈宫曹仁谁厉害? 请无视我做的和划掉的什么的 关于文言文:唐太宗论治天下解读本文的两个关键字是:___ ___选自_____(朝代)______(人名)主编的______(书名),它是___(体史书). 新编初中文言文助读第38篇,原文,注释 化学离子推断题某无色透明溶液中,可能含有以下离子中的若干种:K+、Mg2+、Al3+、Fe2+、Ba2+、NO3-、SO42-、CO32-、I-和Cl-,取该溶液进行如下实验:①将溶液滴在pH试纸上,呈红色.② 后出师表作于蜀军第一次北伐失败后,大臣们对再次北出征伐已颇有异议,但文中却一再提及曹操之败,又言先帝之败,只是为什么 新编初中文言文助读(增订本)1 邴原泣学 我吃过烧焦肉?咋办呢?那天在奶奶家一不小心吃了烧焦的肉,我也知道烧的肉不好吃.但我已经吃了,咋办呢?有没有什么可以补救的办法.5555555我真得挺害怕的 太阳快下山天也暗猜一成语 急求《新编初中文言文助读》 第28课的译文 唐太宗纳谏唐太宗将大臣们的奏章贴在强上,原因是 目的是 用原文回答 有机化学碳正离子的α-C-C旋转是什么? 为什么有时晚上八点太阳早已下山但天还是红的?照常理来说太阳在六点左右已经下山,天早就应该黑了,但是这时的天却很红和以往完全不同,直到晚上八点半天才变黑? 新编初中文言文助读杨振中编的,下篇37、38,只有名字也行, 伞布料有毒吗 我们的太阳ds中如何变天气迷宫中如何变换天气?有一个像石像(木乃伊?)一样的人不管咋么打都没效果,跟各种心灵兽打都没有效果,难道变天气就一定要到研究所去变?还有,暗黑城一开始冰区域 嘉靖皇帝是朱元璋哪个儿子的后代? BaCO3转化成Ba(OH)2 Ba(OH)2转化成HNO3可加入多种物质多次转化 Sunflower is always toward the sun.but the sunflower will be tried sometimes.Till The sky was dark,急Sunflower is always toward the sun.but the sunflower will be tried sometimes.Till The sky was dark,the world is gray,Sunflower no more see the sun.. 嘉靖多少个儿子、 ba(oh)2和hno3的化学方程式和离子方程式 《中国小说史略》到底是白话文还是文言文写的啊 千军易得一将难求兵和将是什么意思 少量Ba(OH)2与HNO3反应方程式 《社戏》 - 鲁迅 文言诗文点击中的一道题《社戏》 第十段的动词运用准确、生动,如:“点、磕、驾”等写出了双喜这帮少年驾船技术的高超.请用80至左右写一段有关某项活动的话,表现连贯 经师易得,人师难求.怎么理解 西北地区外墙保温材料都有那些种类? 诸葛亮《后出师表》中今贼适疲于西中的贼是指什么 “千军易得,一将难求”的“军”和“将”两个字是什么意思? 医用脱脂棉上哪儿去买? 天气为什么会变凉? 一定能在下列溶液中大量共存的离子组是A含有大量铝离子:钠离子,铵根离子,硫酸根离子,氯离子B含有大量三价铁离子的:钠离子,镁离子,硝酸根离子,SCN2- 大家帮我看看我给仓鼠买的脱脂棉对不对、谢了这个是整块给鼠鼠还是撕碎? 急求《治天下必先正心》的译文!...贞观初,太宗谓萧瑀曰:“朕少好弓矢,自谓能尽其妙。近得良弓十数,以示弓工。乃曰:‘皆非良材也。’朕问其故,工曰:‘木心不正,则脉理皆邪, 下列溶液中,一定能够大量共存的离子组是A、滴加石蕊试液显红色的溶液:Fe3+ .NH4+.Cl-.SCN-B、常温下,由水电离出的c(H+)=10^-14mol/L的溶液:CO32-.SO42-.Na+.K+C、与铝反应放出氢气的溶液:K+.SO42-.N 文言文“安有说人主不能出其金玉锦绣,取卿相之尊者乎”的现代汉语翻译 易制剧毒化学品可否快递 下列溶液中一定能大量共存的离子组是?A加入Al粉有氢气生成的溶液中镁离子、铜离子、硫酸根离子、钾离子B使PH试纸呈红色的溶液中Fe2+.I- NO3- Cl-C常温下,c(H+)=十的负十四次方的溶液中钠离子 易制毒是什么呀?易制毒是什么? 易制毒化学品和剧毒化学品的区别?请给我一个详细的答案,答案满意才能给分? 下列四组离子在溶液中能够大量共存的是A.Na+、CO3 2-、Cl-、H+ B.Cu+、Cl-、Na+、S2-C.H+、S2-、Cl-、K+ D.K+、Cl-、Na+、S2+ “变形”却不“金刚”英汉患病被迫宅居日本调查发现:口腔护理有利癌症治疗最贵钻石亮相纽约 估价超六千万美元(空气污染最严峻季节将来临 浙中北多地武林商圈将新增1000个停车位法国两名记者命丧马里(图)韩媒:中国雾霾为“人类历史上最严重污美妇人送儿子手机前“约法18章” 网智利副总统候选人 抱娃上街拉选票(图首份中日韩常用汉字表编制完成 808朝一海军舰艇沉没 金正恩祭拜烈士墓(杭州46岁单身妈妈为儿子过得更好想重俄加强防范“黑寡妇”袭击日本能把俄罗斯“撬走”吗缅甸穆斯林赴邻国避难遇海难 或死伤惨本周四立冬秋天将继续 杭州日后或常雾西湖申遗成功两年多 调研发现景区交通日本未从日俄会谈获实质成果 牵制中国英国男子患怪病 身体变形困家中韩俄峰会拟发涉朝声明俄强化防范“黑寡妇”袭击传三星S6将支持无线充电传苹果将重新设计零售店莎木成史上筹款最多游戏 背后有何启示澳洲四大银行入围世界上最安全的银行这也算还原吗?菲律宾惊现1:1山寨高携战斗机来战!华硕FX-PLUS典藏大盘这里震仓洗盘 只为后半周中阳“一刻”2014年度榜单|最受用户欢智能健康发展铺天盖地 然而并无甚大用“用智慧创造财富,影响行业”房观察全浣熊是我见过最闷骚的动物文玩界三大[黑暗]守护者,你能召唤谁和YOGA称兄道弟!联想Flex 3怀旧|逗比三兄弟拍摄童年VS现在照片不带现金只靠手机 为期两天的生活体验世界再大 也要回家 (漫画版)飘窗这么多功能,你不会才知道吧!春节吃什么零食最健康!带着手品去澳门 vivo X5Pro如果你在街头发现个USB插头时,一定最美不过女厨娘
备案号:鲁ICP备13029499号-2 说三道四 www.s3d4.cn 说三道四技术文摘