apidoc

//@desn:码字不宜，转载请注明出处 //@date:2018/5/6 正文： windows版安装： https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi 2.安装apidoc, linux版安装(ubuntu) 1、更新ubuntu软件源 sudo apt-get update 2、安装nodejs sudo apt install npm 3、更新npm包镜像源 https://registry.npm.taobao.org sudo npm config list 4、全局安装n管理器（用于管理nodejs版本） sudo npm install n -g 5、安装最新的nodejs（stable版本） 6、安装apidoc sudo npm install apidoc -g 使用：以TP框架为例 内容： { "name": "example", "version": "0.1.0", "description": "A basic apiDoc example" } 这里上个我代码里的注释（apidoc就是把注释转换为接口文档） /** * @api {POST} http://118.25.17.80/index

一.安装apidoc所需环境(nodejs) 1. 查看系统是32位还是64位 uname -r 可以看出我这台linux的是64位的 2. 到node官网下载node的包并上传linux https://nodejs.org/en/ 然后通过ftp上传到/usr/bin目录下 3. 进入文件所在目录，解压，重命名 cd /usr/bin tar -xvf node-v10.15.3-linux-x64.tar.xz mv node-v10.15.3-linux-x64 nodejs 4. 建立软连接，变为全局环境变量。 ln -s /usr/bin/nodejs/bin/npm /usr/local/bin/ ln -s /usr/bin/nodejs/bin/node /usr/local/bin/ 5. 测试安装是否成功。显示版本号则表示安装成功！ 二.apidoc 1.安装apidoc npm install apidoc -g 2.建立软连接，变为全局环境变量。 sudo ln -s /usr/bin/nodejs/bin/apidoc /usr/local/bin/ 3.apidoc已经变成全局变量了,开始apidoc之旅吧 参考文章: https://juejin.im/post/5ceba992518825685e02c2fc 　　删除软连接 https:/

团队高效率协作开发的秘密武器 1.前言 在团队协作开发中，不知道各位有没有遇到这样的问题： l 新人接手了项目代码，因没有项目文档，只能靠追踪路由，寻读代码分析业务逻辑 l 前端同学写好了页面，苦等后端接口规则，来写交互请求，获取数据 l 测试同学写测试用例，因项目还没完成，而迟迟无法开工 如何愉快地解决以上问题呢？答案就是它 ——APIDOC。 2.APIDOC是什么 APIDOC是一款Web API文档生成工具，可以根据代码注释自动生成静态html网页文档，不仅支持项目版本号，还支持接口版本号，接口版本更新升级后，文档接口可以很方便地对比阅读。像这样的接口文档生成工具有很多，如Java语言有Javadoc、PHP语言有PHPDoc、Python语言有Pydoc等，为什么要选择用它呢，因为它跨语言，不管你是用js、ruby、java、php、python、c#…，只要按规则写好注释，前后端兄弟都能用。让我们一起来见证它的强大之处吧。 3.先看看使用效果 整体一览 ~ 图 1 接口变更啦，比对阅读一下，清晰明白 ~ 图 2 看看返回数据，测试一发，可以开始写测试用例啦 ~ 图 3 4.具体实现流程 0x01 安装 Windows环境下安装方法： 官网 nodejs.org下载 nodejs 安装好后将 npm 替换为淘宝镜像cnpm npm install -g cnpm -