$ npm i
$ npm run dev
$ open http://localhost:7001/$ npm start
$ npm stop必需安装的插件
| 插件名 | 描述 |
|---|---|
| egg-cors | 解决跨域问题 |
| egg-jwt | 生成 token |
| egg-redis | redis 数据缓存 |
| egg-valparams | 参数校验 |
| crypto | 数据加密 |
可卸载插件
| 插件名 | 描述 |
|---|---|
| node-ldap | 获取活动目录 ad 域数据 |
| egg-sequelize | 数据模型 |
| sequelize-cli | 管理sequelize工具 |
| mysql2 | mysql 模块 |
| nodemailer | 发邮件 |
| uuid | uuid |
- 配置 config/plugin.js
//plugin.js
exports.cors = {
enable: true,
package: 'egg-cors'
};- 配置config/config.default.js
//config.default.js
// 跨域配置
config.cors = {
origin: '*',
allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH',
};
// 开启post请求（关闭csrf规范）
config.security = {
csrf: {
enable: false,
},
// domainWhiteList: [ 'http://localhost:3000' ],
};- 配置 config/plugin.js
//plugin.js
exports.jwt = {
enable: true,
package: 'egg-jwt',
};- 配置config/config.default.js
//config.default.js
// jwt加密配置
config.jwt = {
secret: '123egg_api456',
};- 分别配置config/config.local.js config.prod.js config.test.js 因为上线后每台服务器的配置后有所区别
config.redis = {
client: {
port: 15001, // redis端口
host: '192.168.10.1', // redis ip
password: '123456', // redis 密码
db: 0,
},
};- 配置 config/plugin.js
exports.redis = {
enable: false,
package: 'egg-redis',
};- 配置config/config.default.js
config.validate = {
convert: true, // 对参数可以使用convertType规则进行类型转换
// validateRoot: false, // 限制被验证值必须是一个对象。
};- 配置 config/plugin.js
exports.valparams = {
enable : true,
package: 'egg-valparams'
};- 配置config/config.default.js
// 参数校验
exports.valparams = {
locale: 'zh-cn',
throwError: false,
};- 配置 config/plugin.js
exports.sequelize = {
enable: true,
package: 'egg-sequelize',
};- 分别配置config/config.local.js config.prod.js config.test.js 因为上线后每台服务器的配置后有所区别
config.sequelize = {
dialect: 'mysql', // support: mysql, mariadb, postgres, mssql
database: 'egg-api-local',
host: 'localhost',
port: 3306,
username: 'root',
password: '123456',
// 中国时区
timezone: '+08:00',
define: {
// 取消数据表名复数
freezeTableName: true,
// 自动写入时间戳 created_at updated_at
timestamps: true,
// 字段生成软删除时间戳 deleted_at
paranoid: true,
createdAt: 'created_at',
updatedAt: 'updated_at',
deletedAt: 'deleted_at',
// 所有驼峰命名格式化
underscored: true,
},
};- 安装sequelize-cli
npm install --save-dev sequelize-cli- 在项目根目录下新建一个 .sequelizerc 配置文件：
'use strict';
const path = require('path');
module.exports = {
config: path.join(__dirname, 'database/config.json'),
'migrations-path': path.join(__dirname, 'database/migrations'),
'seeders-path': path.join(__dirname, 'database/seeders'),
'models-path': path.join(__dirname, 'app/model'),
};- 初始化 Migrations 配置文件和目录
npx sequelize init:config
npx sequelize init:migrations执行完后会生成 database/config.json 文件和 database/migrations 目录，我们修改一下 database/config.json 中的内容，将其改成我们项目中使用的数据库配置： 然后通过去创建数据库
#创建数据库
npx sequelize db:create
# 升级数据库
npx sequelize db:migrate
# 如果有问题需要回滚，可以通过 `db:migrate:undo` 回退一个变更
npx sequelize db:migrate:undo
# 可以通过 `db:migrate:undo:all` 回退到初始状态
npx sequelize db:migrate:undo:all文档的使用参考以下链接：
-
配置 config/plugin.js
exports.swaggerdoc = {
enable: true,
package: 'egg-swagger-doc',
};- 配置config/config.default.js
// egg-swagger-doc 配置信息。
config.swaggerdoc = {
dirScanner: './app/controller', // 配置自动扫描的控制器路径。
// 接口文档的标题，描述或其它。
apiInfo: {
title: 'EGG-API', // 接口文档的标题。
description: 'swagger-ui for EGG document.', // 接口文档描述。
version: '1.0.0', // 接口文档版本。
},
schemes: [ 'http', 'https' ], // 配置支持的协议。
consumes: [ 'application/json' ], // 指定处理请求的提交内容类型（Content-Type），例如application/json, text/html。
produces: [ 'application/json' ], // 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回。
securityDefinitions: { // 配置接口安全授权方式。
// apikey: {
// type: 'apiKey',
// name: 'clientkey',
// in: 'header',
// },
// oauth2: {
// type: 'oauth2',
// tokenUrl: 'http://petstore.swagger.io/oauth/dialog',
// flow: 'password',
// scopes: {
// 'write:access_token': 'write access_token',
// 'read:access_token': 'read access_token',
// },
// },
},
enableSecurity: false, // 是否启用授权，默认 false（不启用）。
// enableValidate: true, // 是否启用参数校验，默认 true（启用）。
routerMap: true, // 是否启用自动生成路由，默认 true (启用)。
enable: true, // 默认 true (启用)。
};- 在app目录下新建文件夹contract 在里面书写对应接口的请求和响应的body
//书写格式
// 登录接口响应数据
userLoginResponse: {
data: { type: 'loginResponse' },
message: { type: 'string', description: '响应信息' },
success: { type: 'boolean', description: '是否请求成功' },
code: { type: 'number', description: '响应码,200:成功,否则异常', example: 200 },
},
loginResponse: {
token: { type: 'string', description: '用户token' },
},在控制器中的写法
/**
* @controller LoginController 必须写，区分是哪个类
*/
class LoginController extends Controller {
/**
* @summary 用户登录
* @description 用户登录
* @router post /login/userLogin
* @request body userLoginRequest
* @response 200 userLoginResponse 返回结果
*/
async userLogin() {
const { ctx } = this;
ctx.validate({
account: { type: 'string', required: true, desc: '登录账号' },
password: { type: 'string', required: true, desc: '密码' },
});
if (ctx.paramErrors) {
ctx.fail(ctx.paramErrors[0].err[0]);
} else {
ctx.success('login', '成功');
}
}
}最后通过http://127.0.0.1:7001/swagger-ui.html查看接口
| 目录/主要文件 | 描述 |
|---|---|
| app/controller | 控制器 |
| app/service | 业务层 |
| app/middleware | 中间件 |
| app/model | 数据模型 |
| app/public | 存放静态资源 |
| app/router.js | 存放静态资源 |
| app/contract | 配置swagger请求和响应体 |
| app/extend | 拓展egg的配置 |
| config/plugin.js | 项目插件配置 |
| config/config.{env}.js | 不同环境的配置文件 |
| .sequelizerc | egg-sequeli的配置文件 |
在config目录中新建三个文件,
- config.local.js(本地开发)
- config.test.js(测试环境)
- config.prod.js(正式环境)
修改package.json文件，添加 4 条运行命令
"start-test": "egg-scripts start --env=test --daemon --title=egg-api-test",
"stop-test": "egg-scripts stop --env=prod --title=egg-api-prod",
"start-prod": "egg-scripts start --env=test --daemon --title=egg-api-test",
"stop-prod": "egg-scripts stop --env=prod --title=egg-api-prod",