Technical article: Use Egg.js to build a backend service API (Collection Series)

When I encountered Egg.js when I was learning js, I did a detailed study. It is a Koa-based node development framework launched by Alibaba and is designed for enterprise-level frameworks and applications. How to build a backend service API requires further study. This article mainly introduces Egg.js to build a backend service API. You can refer to it if you need it.

Written before

Because normal development is based on the separation of front-end and back-end, I thought about using Egg to create a back-end service and write a set of API interfaces to cooperate with other projects. The technology stack of this project uses Egg.js, MongoDB, and mongoose. This article records the process of writing the registration and login module and the user center module. The purpose is to summarize the learning process in a timely manner, exercise documentation skills, share and communicate with everyone, and make progress together.

Project address: Egg-API

The project is being continuously updated. If you like it, please like, follow, star, and fork. These are the motivation for me to persist for a long time (..) ✎＿

The following is the text

Requirement analysis

For the registration and login module, the requirements analysis is as follows:

• Register as a new user, and input Verify the data

• Log in to the system, you need to verify the input data, based on token authentication

• Logout function

• Log in to view personal information in the user center module

• Modify personal information in the user center module

Data analysis design

Explicit data:

• userName: String Username

• userPass: String Account password

• userEmail: String User email

• telphone: String Mobile phone number

• avatar: String Avatar

• age: Number Age

• sex: String Gender

• City: String City

Implicit data:

• userRole: Number User role (1. Ordinary user, 2. Administrator, 3. Super administrator, default user For ordinary users, the super administrator creates it when creating the database)

• userCreate: Date User creation time

• lastLoginTime: Date Last login Time

• laseLoginPlace: String Last login address

API analysis and design

The api in the interface description below refers to the interface name , params refers to the incoming data, code refers to the response result identification code, msg refers to the response result information description, data refers to the data returned successfully in the response

Registration interface

api: /api/v1/signup  (post)

params: {
    userName: String,  // 用户名，具有唯一性
    userPass: String,  // 用户密码
    userEmail: String,  // 用户邮箱
}

code: 1、注册成功 0：输入信息不完善或有误 -1：注册失败，该用户名已存在

msg: 响应返回的信息说明

data： {
    _id: _id,
    userName: 用户名,
    token: 生成的token,
}

Login interface

api: /api/v1/signin  (post，请求头带token)

params: {
    userName: String,  // 用户名
    userPass: String,  // 用户密码
}

code: 1、登录成功 0：输入信息不完善或有误  -1：用户不存在

msg: 响应返回的信息说明

data: {
    _id： _id，
    userName: 用户名,
    lastLoginTime: 上次登录时间,
    lastLoginPlace: 上次登录地点,
}

Logout interface

api: /api/v1/signout  (get)

code: 1、登出成功，前端退出系统并清空token

msg: 登出响应返回信息说明

data: {}

View personal information interface

api: /api/v1/user/userName  (post，请求头带token)

params: {
    userName: String,
}

code: 1、查询成功  0、输入信息不完善  -1、查询失败

msg: 查找个人信息返回信息说明

data: {
    userName: 用户名,
    userEmail: 用户邮箱,
    age: 年龄,
    city: 城市,
    ......
}

Change personal information interface

api: /api/v1/user/userName (put,token)

params: {
    ......  // 更改的信息
}

code: 1、更新成功 0、输入信息不完善或有误 -1、更新失败

msg: 更新个人信息返回信息说明

data: {
    userName: 用户名,
    ......
}

Encoding implementation

Note: Encoding implementation instructions are only provided For the complete content, please go to Egg-API

Assume that you have initialized a project and the directory structure of the project is consistent with the official one. Because we want to use the MongoDB database, we must first install egg-mongoose and write in the configuration file:

// config/plugin.js
exports.mongoose = {
    enable: true,
    package: 'egg-mongoose',
};
// config/config.default.js
config.mongoose = {
    url: 'mongodb://127.0.0.1/apiExample',
    options: {},
};

Define our schema file in the model folder:

const UserSchema = new Schema({
    userName: { type: String, unique: true, required: true, },
});

Route definition:

router.post('/api/v1/signup', controller.user.signup);

Controller writing: used to parse user input and return corresponding results after processing. We can put the obtained data into render for rendering, and then send the rendered result to the browser, or we can also directly assign the data to ctx.body and then return it in json mode.

class UserController extends Controller {
    // 登录
    async signin() {
        const { ctx } = this;
        const rule = {
            userName: { type: 'string', required: true, message: '必填项' },
            userPass: { type: 'string', required: true, message: '必填项' },
        };
        const signinMsg = ctx.request.body;
        await ctx.validate(rule, signinMsg);
        signinMsg.userPass = ctx.helper.encrypt(signinMsg.userPass);
        const result = await ctx.service.user.signin(signinMsg);
        ctx.body = result;
    }
}

Service writing: used to write the business logic layer and can be reused. Processing of complex data, for example, the information to be displayed needs to be obtained from the database, or third-party services must be called.

class UserService extends Service {
    // 更新用户信息
    async updateUser(userMsg) {
        const { ctx } = this;
        const res = {};
        const result = await ctx.model.User.findByIdAndUpdate(userMsg._id, userMsg);
        res.code = 1;
        res.msg = '用户信息已更改';
        res.data = result;
        return res;
    }
}

A simple node application structure is like this, so that Egg.js is used to be responsible for the interface service. apache php mysql

Related articles:

How to build a Web server with Nodejs

Server-enterprise website background construction issues

Related videos:

High-performance Linux server building video tutorial

The above is the detailed content of Technical article: Use Egg.js to build a backend service API (Collection Series). For more information, please follow other related articles on the PHP Chinese website!