nodejs 开发api 环境的简单搭建_npm 开发环境api接口

nodejs 开发api 环境的简单搭建

1基础环境

1.1 nodejs npm express

1.2 安装 npm install express-generator -g

2 创建项目

2.1express --view=pug myapp

2.2 安装依赖

cd myapp && npm install
1

2.3 安装dev启动模块

npm i supervisor -g
1

2.4 修改dev启动项

2.5 启动dev 项目

npm run dev
1

3 创建接口文件

3.1创建目录及文件

3.2 引入接口及注册接口

4.编写接口文档

4.1安装依赖

npm i apidoc -g
1

4.2修改package.json 配置

4.3修改user.js 接口内容

　/**
 * @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.
 *
 * @apiSuccessExample Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "firstname": "John",
 *       "lastname": "Doe"
 *     }
 *
 * @apiError UserNotFound The id of the User was not found.
 *
 * @apiErrorExample Error-Response:
 *     HTTP/1.1 404 Not Found
 *     {
 *       "error": "UserNotFound"
 *     }
 */
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

4.4 开启新的命令窗口

apidoc -i api/ -o public/apidoc/
1

4.5 浏览器打开

http://localhost:5000
1

4.6 修改端口号的地方

环境基本完成