nodejs学习笔记

nodejs

1.包管理工具安装(npm、cnpm、yarn)

  npm 
    配置淘宝镜像
    npm config set registry https://registry.npm.taobao.org
    查看镜像
    npm config get registry

    常用的命令  

    npm i   根据package.json 文件下载记录包  

    npm i 包名 --save(-S) | --save-dev(-D) | -g  

    npm uninstall 包名 --save(-S) | --save-dev(-D) | -g  

  cnpm  

    npm install -g cnpm --registry=https://registry.npm.taobao.org  (安装全局cnpm)

    cnpm i   根据package.json 文件下载记录包  

    cnpm i 包名 --save(-S) | --save-dev(-D) | -g  

    cnpm uninstall 包名 --save(-S) | --save-dev(-D) | -g  

  yarn   

    npm i yarn -g    (安装)

    yarn --version  (卸载)

    yarn  根据package.json 文件下载记录包

2. apidoc 接口文档生成

1.安装apidoc

    npm i apidoc -g

2.在项目的根目录配置apidoc.json     (创建一个json文件)
    {
    "name": "cs001",
    "version": "0.1.0",
    "description": "史上最牛逼的api接口文档",  //可以自己取名字
    "title": "cs001",
    "url" : "https:127.0.0.1:3000"
    }

3.在项目的根目录创建apidoc文件夹    

4.注解 apidoc   (注解每一个接口)
    /**
    * @api {get} /user/:id Request User information
    * @apiName GetUser
    * @apiGroup User
    *
    * @apiParam {Number} id Users unique ID.
    *
    * @apiSuccess {String} firstname Firstname of the User.
    * @apiSuccess {String} lastname  Lastname of the User.
    */

5.运行命令生成文档
apidoc -i ./routes  -o ./apidoc
         路由文件夹名字   创建的apidoc文件夹