大家开发的时候难免会查询一些文档,看一下API的调用方法等,所以会不同的语言去某一个地方去找,确实很麻烦,今天给大家安逸两款软件,肯定会让你爱不释手! Dash for macOS 官方地址:https://kapeli.com/dash 1.官方简介 Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline…

介绍 作为一名程序员,工作中学习中免不了是要查询API文档的,毕竟我们能记住的东西有限,而且经常也会碰到某个API一时想不起来的情况,而每次还要打开网页去查询还是挺麻烦的,这时候拥有一个款好用的本地离线API文档大全就派上用场了,得益于Dash(mac),Zeal的文档非常丰富,截止2018.8.23已经有192个API文档了,官方地址:Zeal,拉到最下面可以看到支持的文档列表. (PS:Zeal下载的文档是英文文档,还可以锻炼英文文档的阅读能力哦,貌似也是可以下载中文文档的离线文档包,但是我…

API文档管理工具-数据库表结构思考. PS: 管理工具只是为了方便自己记录API的一些基本信息,方便不同的开发人员 (App Developer, Restful API Developer)之间的工作协调,同时也是由于本人不擅长word文档编写,程序及设计简单,大牛勿喷! API基础信息表 CREATE TABLE API_Infor ( ApiID uniqueidentifier PRIMARY KEY ,ApiCategory int ,ApiSupport nvarchar() ,A…

在 Sandcastle:生成.NET API文档的工具 (帮忙文档) 后提供另一个生成API文档的工具.   1) 准备工作 安装GhostDoc Proc. 收费的哦.... 这个工具的优势是不像Sandcatle那样在生成XML. 选择要生成的项目. 点击生成. 没了.....   关于注释        /// <summary>        /// Datatable转换为Json        /// </summary>        /// <param n…

JApiDocs 详细介绍 简介 JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具.最大程度地利用 Java 的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs 会帮你导出一份漂亮的 Html 文档,并生成相关的 Java 和 Object-C 相关数据模型代码,从此,Android 和 IOS 的同学可以少敲很多代码了,你也不需要费力维护接口文档的变化,只需要维护好你的代码就可以了. 一个简单的示例. 特性 以一个 Controller 作为一组接口导出…

问题: 不同软件/程序在网络中互相传递信息不统一. 交互不便. REST API 作用: RESTful API就是一套协议,用来规范多种形式的前端和同一个后台的交互方式. 原理: 组成/流程/规范: 遵守OpenAPI规范 软件的REST API文档 问题: 在API的迭代开发过程中,文档更新工作容易遗漏. swagger框架 功能: 生成遵守OpenAPI规范的.JSON或YAML格式的RESTful API文档. 实现: 读取嵌入到源代码中的api文档,生成api文档. swagger规范…

api文档设计工具是用来描述和辅助API开发的. 一.RAML https://raml.org/ https://wenku.baidu.com/view/9523238d5ef7ba0d4b733b16.html### RAML(RESTful API Modeling Language 即 RESTful API 建模语言)是对 RESTful API的一种简单和直接的描述.它是一种让人们易于阅读并且能让机器对特定的文档能解析的语言.RAML 是基于 YAML,能帮助设计 RESTful…

链接地址:http://www.cocoachina.com/bbs/read.php?tid=273479 Xcode之外的文档浏览工具--Dash    (在iOS代码库中浏览本帖)       关键字:Xcode插件,插件,API文档浏览 代码类库:其他(Others) GitHub链接:http://kapeli.com/dash   Dash是一款集成了Xcode的API文档浏览工具.虽然可以在Xcode源码编辑器中通过按下Option点击符号来进入文档,但对于不大喜欢用Xcode文档…

主要用途:生成API的文档 源码链接:https://github.com/tmcw/docbox 最近刚好在看:Trending in open source,在JS语言中,slate一直在周排行上高居榜首,至少在我看的这一周当中,一直排行第一~ 有点好奇的点进去看了,原来是一款用于生成API文档的东东.本来打算clone下来到本地运行一下,结果ruby那边版本一一直报错,现在都没有解决了,于是乎,看到一个跟跟slate很像的玩意儿,Docbox,为什么要选择它呢? 1.基于Node环境,不需…

AspNetCore.ApiDoc 简单徐速一下为什么选用了aspnetcore.apidoc 而没有选用swagger 最初我们也有在试用swagger,但总是有些感觉,感觉有点不满意,就但从api文档角度来说,从前后端文档沟通角度来讲 apidoc的表现形式,要比swagger简单的多,效果也要好很多. 不要和我说什么swagger现在已经是一个标准了,其实swagger的坑很多,就单说枚举类型抓取上,就显示的很无奈,下面我会创建项目,写一个接口,拿这个接口举例,同时用apidoc和swag…

本来想下载一个dash来用一下,结果它只有mac版本,没有windows版,遂使用zeal zeal官网:https://zealdocs.org/ 文档地址:http://kapeli.com/docset_links 1.下载安装zeal 下载下来,进行安装,点击下一步下一步就可以了! 安装完成!但是没有文档! 2.下载文档解压放置于zeal的docsets文件下 重新打开zeal mysql的api文档已经被加载进来,可以使用搜索了!--------------------- 作者:安善良…

1.官网:https://zealdocs.org/download.html#windows 2.github:https://github.com/zealdocs/zeal 3.下载:可下载安装包和zip包. 4.下载后是没有API文档的,需要手动下载指定的API 点击左上角选项Tools > docsets 打开如下面板: 左边的选项卡installed,是你已经下载的文档,右边的选项卡则是可以下载还未下载的文档,双击进行下载.稍微等候一会就会下载完成并出现在Zeal的主页面中左侧列表.…

谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景 没有背景.就自己做自己的背景 在当今各种盛行的前后端分离.restful service开发过程中,接口文档是必不可少的.对于前后端分离的开发中,后端开发需要将接口写好后需要告诉前端工程师接口的请求参数.响应示例等重要信息,而对于对外暴露的restful接口服务,我们提供接口也是需要具备相同的接口文档的. 但是对于后端工…

系统庞大之后,前后端分离开发,前端调用后端提供的接口,请求协议一般是 HTTP,数据格式一般是 JSON.后台只负责数据的提供和计算,而完全不处理展现逻辑和样式:前端则负责拿到数据,组织数据并展现的工作.这样结构清晰,关注点分离,前后端会变得相对独立并松耦合.好处多多. 但是这样带来很多问题,前端可能需要拿到后端的数据之后,才能开始开发工作,等前端开发完成之后,然后再与后端一起联调.耗时不说,如果业务的需求更改,后端接口变更,怎么快速便捷告知前端的开发人员?还有其他如文档维护和及时更新的问题.这…

http://www.stack.nl/~dimitri/doxygen/index.html 非常的方便. 2步生成API文档. 具体信息见官网哟!…

点击查看apidoc生成文档demo 1 环境和工具 win10 apidoc:注释生成api文档 wkhtmltopdf:apidoc生成的是html,不适合传播,于是通过wkhtmltopdf将html转换成pdf文件 git:命令行工具和代码版本控制工具(非必要) Typora:markdown文件编辑工具(非必要) 文本编辑工具:VSCode(非必要) 2 准备 (1)apidoc的安装 安装Nodejs 官网地址:http://nodejs.cn/download/ 根据自己的系统环境…

要为编写的程序编写文档,这是件费力气的事,如果能自动生成就好了. 不怕做不到,就怕想不到.这不,搜索到了Sandcastle 比较好的参考文章: 1.Sandcastle官方网址: http://shfb.codeplex.com/ 2.使用SandCastle创建.Net帮助文档 http://www.cnblogs.com/DotNetNuke/archive/2009/04/23/1441899.html 3.NET项目工程生成一份项目帮助文档chm--Sandcastle工具 参考这篇文…

背景 2012 年之前几乎没有为代码增加注释,当然,代码的命名也不见得合理(好的代码胜过面面俱到的注释),后来接触过一些开源框架,优秀的框架都有一个特点:文档和示例非常多,在后来的日子里,几乎会强制自己为代码写注释,可能是有点过犹不及了,不过凡事都会经过这个初级阶段,本文总结一下使用过的文档生成工具. Javascript 文档生成工具 Javascript 这种动态语言更应该写注释. YUIDoc 网址:http://yui.github.io/yuidoc/. JsDuck 网址:https…

其实使用doxygen在Cocos2d-x引擎的doc目录下可以生成离线文档,但是可能每个人为了生成一个离线文档去安装甚至编译doxygen毕竟麻烦,而且现有的doxygen无法生成多语言版本的离线文档.所以为了大家用起Cocos2d-x更方便,在子龙山人的帮助下,我把最新多语言版Cocos2d-x的离线文档给整理出来了. 特点: 1.版本:使用最新的2.x版本和3.x版本. 2.语言:右上角选择C++/JS/Lua即可进行语言切换. 3.跨平台:这里没有使用chm等其他格式,而是直接使用了ht…

Simple doc是一个简易的文档发布管理工具,为什么要写Simple doc呢?主要原因还是github的wiki并不好用:没有目录结构,文章没有Hx标签索引,最悲剧的是文章编辑的时候不能直接图片粘贴和文件上传;为了满足自己的需求也顺带帮Beetlex写个完整的web示例所以花了些时间写了Simple doc.虽然Simple doc功能简单但在文档展现上还是要比github的wiki好上不少,所以在完成后也把github的wiki迁到这上面来了(毕竟都是基于markdown所以迁过来也简单…

(1)准备软件 首先需要我们准备如下软件: SandCastle, 下载地址: http://sandcastle.codeplex.com/releases/view/47665 (2)准备项目文件 准备好程序的dll文件和注释的xml文件.比如本文实例的两个文件:XmlCommentClassDemo.dll 和 XmlCommentClassDemo.XML 注意如果我们的项目关联多个dll,则需要将相关的项目的dll和注释xml文件都准备好.否则的话在帮助文件中将不能点击相关的类.(如果…

/*查阅api ---context1.abstract AssetManager     getAssets() Returns an AssetManager instance for the application's package. 得到assets目录下的资源 2.abstract File     getCacheDir() Returns the absolute path to the application specific cache directory on the fi…

package question; import java.util.Scanner; import java.lang.Math; public class MathTest { /** * 未搞懂 * @param args */ public static void main(String[] args) { // TODO Auto-generated method stub System.out.println("请输入圆的半径:"); Scanner in =new Sca…

今天各种MVC框架满天飞,大大降低了编码的难度,写实体类就没有办法回避的一件事了,花大把的时间去做一些重复而且繁琐的工作,实在不是一个优秀程序员的作风,所以多次查找和尝试后,找到一个工具类网站——Api管家 这也太直白了,卡通的背景,好像不怎么样...先试用看看 好吧,先创建个试试 果然出现了一个项目,进去看看 5个接口的示例,看起来还挺清爽,+1分,随便点点... 好多按扭啊...点点看,代码生成在哪里啊... 这个是什么鬼!有毛用... 再试试... 进编辑了... 慢点再研究,继续找...…

前言介绍 Yapi 由 YMFE 开源,旨在为开发.产品.测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建.发布.维护 API. 权限管理 YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求 可视化接口管理 基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率 Mock Server 易用的 Mock Server,再也不用担心 mock 数据的生成了 自动化测试 完善的接口自动化测试,保证数据的正确性 数据导入 支持导入…

https://zealdocs.org/    开源.免费,支持Linux.Windows http://velocity.silverlakesoftware.com/  https://kapeli.com/dash…

原文地址:https://www.jianshu.com/p/a97d2efb23c5…

前言 相信很多后端开发在项目中都会碰到要写 api 文档,不管是给前端.移动端等提供更好的对接,还是以后为了以后交接方便,都会要求写 api 文档. 而手写 api 文档的话有诸多痛点: 文档更新的时候,需要再次发送给对接人 接口太对,手写文档很难管理 接口返回的结果不明确 不能直接在线测试接口,通常需要使用工具,如 postman 等 Swagger 就很好的解决了这个问题. Swagger 简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 W…

Bullet 全称 Bullet Physics Library,是著名的开源物理引擎(可用于碰撞检测.刚体模拟.可变形体模拟),这里将bullet的学习资源整理一下,希望能帮助入门者少走弯路. 看下wikipedia的介绍还是必要的: http://en.wikipedia.org/wiki/Bullet_(software) 看完才知道,好多大片都用的Bullet做物理模拟,如电影<2012>,这应该能增加你对Bullet的兴趣吧. 官方网站: http://bulletphysics.o…

随着前后端的分离,借口文档变的尤其重要,springfox是通过注解的形式自动生成API文档,利用它,可以很方便的书写restful API,swagger主要用于展示springfox生成的API文档. 官网地址:http://springfox.github.io/springfox/ Springfox大致原理 springfox的大致原理就是,在项目启动的过种中,spring上下文在初始化的过程,框架自动跟据配置加载一些swagger相关的bean到当前的上下文中,并自动扫描系统中可能需…