你的项目是用什么工具写api文档的？今天就给大家推荐一下ApiDoc。1、什么是ApiDoc？ApiDoc可以根据你在代码中的注释生成api描述文档，这样你就不用告诉你的朋友到底怎么调用你的api了。目前支持的编程语言有：Java、Javascript、Php、Python、C#、Ruby、Lua等，支持所有主流编程语言。2.如何使用？很简单，在你的代码中用这样的注解声明你的接口信息即可/***@api{get}/user/:id请求用户信息*@apiNameGetUser*@apiGroupUser**@apiParam{Number}id用户唯一ID。**@apiSuccess{String}firstname用户的名字。*@apiSuccess{String}lastname用户的姓氏。*/这里的这些注解是ApiDoc定义的，你只需要按照官方的Documentation就可以了。ApiDoc官网3.开始安装npminstallapidoc-grunapidoc-iapi/-odocs/api是你的代码目录，也就是你使用注解的文件目录，它会自动扫描使用注解的文件。docs文件要生成api文档的目录也是githubpage最后要用到的目录。查看api文档直接在docs目录下打开index.html查看最终结果。4.githubpagegithubpage是一个免费的网络服务，允许你发布你的静态页面供其他用户通过浏览器查看。我们刚才生成的文档内容在我们本地，现在需要发布到github上，创建一个github仓库把我们自己生成的Diaman放在船上，即docs的整个目录由pageservice提供在仓库的设置。url访问摘要ApiDoc提供更好的API文档阅读体验，免去开发者编写文档的烦恼。但是缺点是不能像swagger一样提供在线调试，需要大量的注释来描述一个api。
