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

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

8000美元存储135TB数据:打造开源的存储硬件 Bing,每月27亿的有效搜索不及僵尸网络的一半 为什么说Amazon的James Hamilton是“可遇不可求”的? Facebook背后的数据团队 红帽将产品转移到Apache社区 Impala是如何提升3~90倍查询效率的? 云中保障数据安全及完整性必须防范的遗留问题 VMware推出移动性平台:VMware Horizon Suite 移动周报:全球最大校园Hackathon的参赛宝典 Unity3D首届游戏创意设计大赛开始报名 中国日报:向移动新媒体蜕变 C#五子棋程序设计 Mozilla宣布推出Firefox OS 面临四大问题 Ruby 2系列首个稳定版 Ruby 2.0.0-P0发布 微软改进Windows Blue搜索 系统或今夏推出 移动新趋势:扁平化设计 vs. 拟物化设计(下篇) 传奇程序员:Minecraft开发者Notch大神 让沟通更便捷 ConnectYard宣布推出全新的Web API 在Hadoop上运行SQL:程序员需知晓的13种数据工具 怎样用好Eucalyptus? AWS攻势变猛,Rackspace主动降价CDN与云存储 惠普将于下季度推出低功耗的Moonshot服务器 webOS复活!LG收购webOS用于智能电视 那些因为HTML5而将消亡的产品 初窥iWatch用户界面:开创基于时间的全新体验 如何编写出拥抱变化的代码? 20个优秀的前端框架 以AWS和vCloud为标杆看四大开源平台的定位 桌面集成开发环境五年内必将“死亡”? 助影人圆梦奥斯卡 8mm相机应用其实很平庸 苹果应用审查团队叫停Cookie追踪技术 急!!小弟现在用midas做一个三层的系统,用Dcom连接,但是在客户端连接服务器说类字符串未注册 关于选择菜单的这个功能怎么实现 高分求书:用DELPHI搞数据库的书! 关于Potoshop编程的有关问题,知道的请进! 如何改变列表题背景颜色,数据窗口控件用的是动态sql语句。 如何把unsigned long型的对方IP地址,设在ClientSocket的IP中 开发游戏软件一般要用到什么编程工具和编程语言? 为什么 semaphore 和 event variables 是不好的? 在dos下,如何用汇编语句获知XXX盘符是否为网络盘或本地盘或substed盘??? 如何实现字符串种的准确查询! 灰头土脸的问 F7 & F8 区别到底是什么? 我看着都是单步.... 如何在 windows下 破解 写保护卡? VC+ADO,怎么实现把*.DBF表导入SQLServer2k里。 一个关于库文件的问题 我在用VB编数据库SQL SERVER,想实现数据库中关键表在本地磁盘中备份,通过代码应该怎样实现 谁想与我交换主页链接 一个程序编译通过后,我把paradox数据表的某一字段由N型改为了A型,结果运行时出错,应该怎么做呢? 如何用存储过程将一个查询的结果存为本地的一个XML文件? 有人知道.DUL文件是什么东西,有什么用,怎么创建? 如何把richtext.text的内容发到直接激活的word文档中?(在线等待) 高人指点,高人救命,我急。这是我唯一的办法了。 C++中为什么析构函数可以是虚函数,而构造函数不可以是虚函数? 100分求救:谁有webeasymail的解密版本或是能用的注册机??? 寻求C++参考书 高分问一个简单问题,什么叫“RAM驱动器”? 关于运算符重载的问题,请高手进来看看 如何把unsigned long型的对方IP地址,设在ClientSocket的IP中 为什么打开防火墙后,别人不能浏览自己的主页了? 钩子函数 请问如何唤醒机器? 关于ADOQUERY的问题?? 为什么打开防火墙后,别人不能浏览自己的主页了? ■■■征集顶级域名■■■ 谁知道在WIN2000有没有象WIN98中的WINPOPU发送信息的文件,若有,文件名为什么? 云南的程序员考试者看过来!!!一起来交流一下吧!!! 为什么打开防火墙后,别人不能浏览自己的主页了? 请你帮助! 谁知道在WIN2000有没有象WIN98中的WINPOPU发送信息的文件,若有,文件名为什么? 请教pnm和rtsp协议?请问哪儿有相关技术资料下载?谢谢! VC.NET那个变态的属性太难用了!!!我怎么死活都找不到我定义的消息??? 你们遇没遇到在builder中显示 link error提示的?? 请教pnm和rtsp协议?请问哪儿有相关技术资料下载?谢谢! 为什么在form1的paint事件中加入"form1.refresh语句后,在不做任何动作的情况下,事件会连续发生???你们有这种现象吗? 数据表格数据的块粘贴,如何实现? 网络病毒!急救! SOS 救命!!!!!! 为什么打开防火墙后,别人不能浏览自己的主页了? 急,判断某个记录是否为空的语句怎么写???除了record="" ,还有一个 jrun下如何配servlet,急急急 一个简单的问题,有劳各位了! 各种重生穿越成动物的,最好字数要多的(各种成猫狗牛羊老虎狮子豹子) 在平行四边形ABCD中,BE垂直CD,BF垂直AD,垂足为E、F,BE=2cm,BF=3cm,角EBF=60求平行四边形ABCD的面积 关于雪的排比句像.像.像.像. 是狮子,猫,狗,牛,马五种动物 在正方形ABCD中,F是AD的中点,BF与AC交于点G,则三角形BGC与四边形CGFD的面积之比为多少 马尾巴做琴弦_不值一弹.弹字的谐音是什么 猫在盒子里,用英语怎么说? 心理测试,如果把自己比成动物,1狗 2猫 3马 4牛.四种选择代表什么性格 洗衣机甩干桶起动慢没劲还有点响洗衣机甩桶不转了 找了_个电容和电机〈成套旧的〉 换上以后就不顺 没劲 今天没事 把4VF换成8VF试了 有响声 又换过来还是有响比以前还慢 怎么 某车间有两小组,甲组组乙组的比是5:3,现在甲组调14人到乙组后,甲组与乙组的人数是1:2,两组现各有多少人? 有人问我有四种动物狮子老虎猫和狗成为其中的一个,不知道是什么意思 甲乙两辆汽车分别从A、B两地相向而行,速度比是7:11,相遇后两车继续行驶,分别 英语翻译这里有只猫在盒子里 There _____ ______ ______in ______ ______. 谁有狗,鸡,鸭,猫,羊,老鼠,狼,狮子,牛,龙,猿这些动物叫声的象形词?还有老虎 双桶洗衣机维修没有甩干点击没劲怎么回事 特仑苏牛奶好吗?青少年喝什么牛奶好呢? 一个四面体各棱长都为 根号下2 ,四个顶点在同一球面上,则此球的表面积为(  )为什么能扩展成正方体?角度不一样啊 甲乙两辆汽车分别从A、B两地同时相向而行,速度比是7:9相遇后两车继续行驶,到达 特仑苏牛奶有什么问题,儿童能喝吗? 长方形ABCD的面积是120平方厘米,AE是ED的2分之1,AF是AC的4分之3,求三角形BEF 甲,乙两辆汽车分别从A,B两地同时相向而行,速度比是7:11,相遇后两车继续行驶,分别到达B、A两地后立即返回,当第二次相遇时,甲车距B地80千米,两车共行了3个A、B两地的路程,A,B两地相距多少千 —Would you like to have some tea or juice?—_______,coffee is OK.A.EitherB.NeitherC.BothD.None我选A,可答案是B,请问为什么? 六三班同学参加两项课外体育活动80%人参加打乒乓球,75%参加跳绳.有22人两个项目 设四面体的各条棱长都为1,若该四面体的各个顶点都在同一球上的球面上,求球的表面积 would you like some coffee or tea?—______.water is ok.A.Both B.Either C.Neither D.All 某班有五十名学生,现在会打兵乓球的有32人,会打乒乓球又会跳绳的有18人,其中每人至少会一样,那么会跳绳的学生有多少名? 棱长都为√2 的四面体的四个顶点在同一球面上,则此球的表面积为 猫属于哪类动物? 跳绳的同学有12人,是打乒乓球的1.5倍,打乒乓球的有多少人? 一个四面体的所有的棱长都为√2,四个顶点在同一个球面上,则此球的表面积为 -Would you like some juice and coffee?-( )I like green tea instead.both,either or neither.这里的instead什么意思 歇后语:马尾巴撮绳-----? 牛奶盒子是用什么做的? 哪些动物属于猫类? 如图,长方形ABCD的面积是100平方厘米,EB=5分之2AB,BF=8分之5CB,那么长方形FGEB的面积是() 奶盒子怎么能揉开我现在生完宝宝以经一个多月了,奶一直不够吃吃,可以这么说,大部分都是吃的奶粉,而且有点奶就漏了,现在右边乳房挺大的,奶比左边多一些,硬块也多,左边乳房比较软,但是 猫属于i什么动物 如图,长方形ABCD的面积是100平方厘米,EB=五分之二AB,BF=八分之五C.那么长方形FGEB的面积是多少 如图长方形ABCD中,AB=10,AD=14,BF=CE=6,求阴影部分的面积 什么动物和猫一个类? 双缸洗衣机洗4件衣服定时多久?放多少洗衣粉 多少水? 牛奶为什么装在方盒子里? she would like some orange juice怎么翻译 用洗衣机洗衣服,用洗衣粉洗完头道后,每次清洗之前都要先脱水甩干衣服的泡沫吗?用洗衣机洗衣服,头道用洗衣粉洗完后,每次清洗之前,需要先脱水甩干衣服的泡沫后,再清洗 这样清洗得要更 为什么牛奶装要在方盒子里卖? 哪里有语文优美排比句 跳绳的有18人,乒乓球的有22人,有8人两项都参加,问各有几个人参加跳绳的打乒乓球? 什么尾搓绳 歇后语 847亿等于多少千? 六三班同学参加两项课外活动80%人参加打乒乓球,75%参加跳绳.有22人两个项目都参加,参加课外体育活动有()人 所有楞长都为根号2的四面体,四个顶点在同一球面,求这个求的表面积..3π... 已知,如图,在菱形ABCD中,E,F分别是AB和BC上的点,且BE=BF.求证,(1)△ADE≌已知,如图,在菱形ABCD中,E,F分别是AB和BC上的点,且BE=BF. 求证,(1)△ADE≌△CDF (2)∠DEF=∠DFE 马尾巴提豆腐-----( )牛皮灯笼-----( )歇后语马尾巴提豆腐-----( )牛皮灯笼-----( ) 从生产的粮食中抽出20袋检查质量,以每袋50千克为标准,将超过的千克数记为正数,不足的千克数记为负数,记录如下:单位 -0.7 -0.5 -0.2 0 0.4 +0.5 +0.7袋数 1 3 4 5 3 3 1这20袋大米总计超过多少千克或 1万4千等于1. 歇后语 马尾巴串豆腐后面是啥 在四边形ABCD中,AB=AD,∠ABC+∠ADC=180°.E,F分别是边BC,CD上的点,且∠EAF=2/1∠BAD,求证:EF=BE+DF 已知,如图,在菱形ABCD中,E,F分别是AB和BC上的点,且BE=BF 求证:△ADE全等△CD已知,如图,在菱形ABCD中,E,F分别是AB和BC上的点,且BE=BF 求证:△ADE全等△CDF;⑵∠DEF=∠DFE 在平行四边形ABCD中,BE垂直CD,BF垂直AD,垂足为E、F,BE=2cm,BF=3cm,角D=120度.求平行四边形ABCD的面积D E CFA B 三角形全等:已知如图在正方形ABCD中AB=AD∠B=∠D=90°(1)如果BE+DF=EF求证
备案号:鲁ICP备13029499号-2 说三道四 www.s3d4.cn 说三道四技术文摘