# api_nodejs_template

**Repository Path**: tiaya/api_nodejs_template

## Basic Information

- **Project Name**: api_nodejs_template
- **Description**: nodejs开发api的模板
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-01-22
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 项目工程初始设定

记录工程初始设定。开发时，直接使用设定好的文件，可以跳过这一步。

选择一个目录作为workspace，新建文本文件package.json，按照npm的帮助文档输入项目信息。
这个文件中会记录npm依赖包信息。

执行 
npm install -save koa@2.0.0
npm install -save koa-router@7.0.0
npm install -save koa-bodyparser@3.2.0
npm install -save nodemon


### 项目工程导入

下载api目录，进入目录，执行 npm install，安装依赖包。
注意：不要向svn上传依赖包目录 node_modules 和 package-lock.json。


### 目录结构

- .vscode 开发工具使用的项目设定信息目录
- controller: api目录
  - mock： mock模拟用api目录，根据模块划分子目录
  - server： 开发测试用api目录，根据模块划分子目录
- app.js 入口文件
- controller.js: api扫描注册
- rest.js: 辅助生成api返回值
- package.json npm配置文件

以下目录为开发时临时目录，不需要上传到服务器。

- node_modules npm依赖文件，根据package.json安装
- package-lock.json  npm依赖文件，根据package.json生成

通过执行node app.js 启动服务器.


### 工作

我们需要做的就是在controller目录下,添加我们需要的api接口.
写法可以参考mock/heroes.js,里面有详细代码注释.