apidoc的使用

  1)安装node.js: https://nodejs.org/download/

从0.6.1开始,Node.js在Windows平台上提供了两种安装方式,一是.MSI安装文件,另外还有一个.EXE可执行文件。

  2)下载npm源代码: https://github.com/isaacs/npm/tags

  3)将npm源代码解压到D:\npmjs目录中

    安装命令:D:\>cd npmjs

           D:\npmjs>node cli.js install -gf

  4)安装apidocjs

    安装命令:npm install apidoc -g

5)安装express:

npm install express -g //安装最新版express

npm install [email protected] //安装指定版本express

npm remove express -g //删除express

  5)生成apidoc文档:

    替换模板:E:\node.js\node_modules\apidoc\template\utils\handlebars_helper.js

            E:\node.js\node_modules\apidoc\template\index.html

时间: 2024-10-10 04:15:49

apidoc的使用的相关文章

如何利用apidoc来写接口文档

在开发后台接口的过程中,肯定要提供一份api接口文档给终端.一直用word写,太丑了..怎么才能做出一份漂亮的api文档呢?找了好久发现了今天的主角-apidoc. 官网地址:http://apidocjs.com 开放API已经成为当下主流平台的一个要素,特别对于社交.电商类的平台开放API更成为了竞争力的一种.开放API文档的完整性.可阅读性往往影响着接入方是否能顺利地.快速地接入到平台,一份好的.统一的API文档也是开放平台不可或缺的要素. apidoc是通过源码中的注释来生成API文档,

vs开发nodejs api文档生成神器-apidoc

直接生成文档的神器 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.

laravel中使用apidoc

apidoc官方文档:http://apidocjs.com/#params 第一步:使用:npm install apidoc -g 命令安装apidoc. 第二步:在项目根目录下新建apidoc.json文件,文件内容格式参考如下: {   "name": "laravel5 API文档",   "version": "v1.0",   "description": "本文档提供laravel

apidoc

路径: /opt/webapps/apidoc/apidoc/ -----存放页面生成的地方: http://172.18.22.56:8213/apidoc/index.html (all,所有api的doc) http://172.18.22.56:8213/apidoc/relation/index.html (gongzuoquan-relation-rest) http://172.18.22.56:8213/apidoc/acount/index.html (gongzuoquan-

ApiDoc 文档使用方式

1.安装node.js 2.打开node.js 命令窗(shell)键入npm install apidoc -g 自动安装(几分钟) 3. C:\Users\user\AppData\Roaming\npm\node_modules\apidoc\example 目录下的example.js是文档的模板,用来生成我们需要的文档 在C:\Users\user\AppData\Roaming\npm\node_modules\apidoc下新建一个文件夹doc(自定义即可),作为文档输出目录 Ps

apidoc,一个相当不错的文档生成器

http://apidocjs.com/ 例子:myapp目录下的MyCode.java /** * * @api {get} /company/list 获取公司信息 * @apiName 获取公司列表 * @apiGroup All * @apiVersion 0.1.0 * @apiDescription 接口详细描述 * * @apiParam {int} pageNum分页大小 * * @apiSuccess {String} code 结果码 * @apiSuccess {Strin

关于apidoc文档生成不了的一个原因

前几天在写完API后,写注释文档,然后很习惯的去用apidoc取生成注释文档,但是奇怪的事发生了,没有注释的内容,也没有报错:注释代码如下: /* * @api {get} /applet/:id 根据编号,获取场地id * @apiGroup applet * @apiVersion 2.2.0 * @apiParam {integer} id 二维码编号 * @apiSuccessExample {json} Success-Response: * { "code": 1, &qu

Web API文档生成工具apidoc

apidoc可以根据代码注释生成web api文档,支持大部分主流语言java javascript php coffeescript erlang perl python ruby go...,相对而言,web接口的注释维护起来更加方便,不需要额外再维护一份文档. apidoc从注释生成静态html网页文档,不仅支持项目版本号,还支持api版本号. 安装 主页: http://apidocjs.comgithub: https://github.com/apidoc/apidoc可以使用npm

apidoc 生成文档

相关链接 :https://www.npmjs.com/package/apidoc 用apidoc可以生成文档, 预制条件: 1 项目根目录下新建一个文件:apidoc.json 2 项目目录下新建一个文件夹: doc apidoc -i example/ -o doc/ Creates from input files in example/ a documentation in path doc/.

通过apidoc生成api文档

参考: http://apidocjs.com/ http://blog.csdn.net/xumin198908/article/details/41964159 1)环境准备(前提是已经具备nodejs环境) npm install apidoc -g 2)添加注释 /**  * @api {get} / 请求APP信息  * @apiName  请求APP信息  * @apiGroup User  *  *   *  * @apiSuccess {String} return_code F