nodejs && apidoc】的更多相关文章

1. 安装nodejs      http://www.nodejs.org      源码编译      configure —prefix=/usr/local/nodejs      make && make install 2. 安装apidoc       npm install apidoc -g   …
作为后台根据需求文档开发完成接口后,交付给前台(angular vue等)做开发,不可能让前台每个接口调用都去查看你的后台代码一点点查找.前台开发若不懂你的代码呢?让他一个接口一个接口去问你怎么调用,需要传递那些参数?调用方法?这样的话,微信公众号之类的二次开发去找谁要接口调用,这显然是不切合实际的.所以有一个后台接口调用的展示文档,对前后端分离的开发来说,非常实用.之前在.net 开发中使用过swagger作为后台接口API文档的生成方式.感觉很简单,一步到位.下面介绍一下在nodejs 中采…
直接生成文档的神器 apidoc 1 win+R 输入 cmd 回车 然后进入 nodejs 项目目录 例如 D:\NodeTest\newApp1 2  用npm安装 apidoc 直接输入 npm install apidoc -g  按回车 3 打开项目的 package.json文件 加入 "apidoc": { "title": "apiDoc在浏览器中的标题", "url" : "https://api.…
1.安装node http://nodejs.cn/download/ 下载二进制包,解压,配置环境 export NODE_HOME=/usr/local/nodeexport PATH=$NODE_HOME/bin:$PATH node -v 检查 2.修改node默认镜像 npm config ls -l 查看配置项 npm config set registry "http://registry.npm.taobao.org" 3.全局安装apidoc npm install…
apiDoc基于rest的web API文档生成器,可以根据代码注释生成web api文档,自动生成静态的html网页文档,不仅支持项目版本号,还支持API版本号. 使用apiDoc不需要自己麻烦的调word的格式,就可以生成一份漂亮的API文档.既美观又可以装逼...先看效果 1.安装: php运行环境:php(5.5.12) +  apiDoc .apiDoc的安装我们可以通过 npm 命令来安装.apiDoc基于NodeJS实现,所以你需先有NodeJS及NPM环境 windows安装no…
来源:http://blog.csdn.net/xumin198908/article/details/41964159 在开发后台接口的过程中,我们肯定要提供一份api接口文档给终端app. 目前大多数的app的接口请求应该都是http+json的方式. 但是一直苦于做不出份漂亮的api文档,用word写,也太丑了..怎么才能做出一份像腾讯.新浪微博等各种开放api平台那样漂亮的api文档呢?找了好久发现了今天的主角-apidoc. 官网地址:http://apidocjs.com 开放API…
1.安装nodejs.下载网址:http://www.nodejs.org: 2.安装apidoc.运行cmd,切换到nodejs的安装目录,在命令行输入: 1 npm install apidoc -g ,完成apidoc的安装. 3.在nodejs的安装目录新建一个myapp的文件夹(用于放接口源码文件,文件为js格式,源码如下). 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27…
//@desn:apidoc linux环境  windows环境使用 //@desn:码字不宜,转载请注明出处 //@author:张慧源  <turing_zhy@163.com> //@date:2018/5/6 正文: windows版安装: 1.安装nodejs   (nodejs环境) 32 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi 64 位安装包下载地址 : https://nodejs.org/d…
工具名称:APIDOCGit地址:https://github.com/apidoc/apidoc 项目地址:http://apidocjs.com/ 样例项目:http://apidocjs.com/example_basic/ APIDOC使用指南:https://www.jianshu.com/p/34eac66b47e3 全局安装 安装NodeJS后自动安装了npm管理工具,使用npm管理工具在cmd下安装apidoc 注意:Windows用户需在cmd下执行安装命令,不要在git ba…
apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java.C.C#.PHP和Javascript等.使用者仅需要按照要求书写相关注释,就可以生成可读性好.界面美观的在线接口文档.本文主要包含以下内容: 介绍apidoc的基本概念 安装.使用和简单配置 一些特殊参数的含义及其使用 介绍一些使用经验 前言 apidoc能做什么 apidoc是一个轻量级的在线REST接口文档生成系统,可以根据其特定的规则的代码注释来生成静态网页.首先看下它生成的文档界面和风格. 支持 a…