Article technique : Utiliser Egg.js pour créer une API de service backend (Collection Series)-js tutoriel-php.cn

Article technique : Utiliser Egg.js pour créer une API de service backend (Collection Series)

php是最好的语言

Libérer： 2018-07-27 17:05:44

original

4433 Les gens l'ont consulté

J'ai rencontré Egg.js lorsque j'apprenais js et j'ai fait une étude détaillée. Il s'agit d'un framework de développement de nœuds basé sur Koa lancé par Alibaba. Il est né pour les frameworks et les applications au niveau de l'entreprise. Comment créer une API de service backend nécessite une étude plus approfondie. Cet article présente principalement Egg.js pour créer une API de service backend. Vous pouvez vous y référer si vous en avez besoin.

Ce que j'ai écrit avant

Parce que le développement normal est basé sur la séparation du front-end et du back-end, j'ai pensé à utiliser Egg pour créer des services back-end et écrire un ensemble d'API interfaces pour coopérer avec d’autres projets. La pile technologique de ce projet utilise Egg.js, MongoDB et mangouste. Cet article enregistre le processus d'écriture du module d'inscription et de connexion et du module du centre utilisateur. Le but est de résumer le processus d'apprentissage en temps opportun, d'exercer les compétences en matière de documentation, de partager et de communiquer avec tout le monde et de progresser ensemble.

Adresse du projet : Egg-API

Le projet est mis à jour en permanence, veuillez aimer, suivre, mettre en vedette et bifurquer. C'est la motivation pour moi de persister dans le. long terme (.＿.) ✎＿

Ce qui suit est le texte

Analyse des exigences

Pour le module d'inscription et de connexion, l'analyse des exigences est la suivante :

Inscrivez-vous en tant que nouvel utilisateur, saisissez Vérifiez les données
Connectez-vous au système, vous devez vérifier les données saisies, en fonction de l'authentification par jeton
Fonction de déconnexion
Connectez-vous pour afficher les informations personnelles dans le module du centre utilisateur
Modifier informations personnelles dans le module centre utilisateur

Analyse et conception des données

Données explicites :

userName : String Username
userPass : chaîne Mot de passe du compte
userEmail : chaîne e-mail de l'utilisateur
telphone : chaîne numéro de téléphone portable
avatar : String Avatar
âge : Nombre Âge
sexe : String Genre
City : String City

Données implicites :

userRole : Numéro de rôle de l'utilisateur (1. Ordinaire utilisateur, 2. Administrateur, 3. Super administrateur, utilisateur par défaut Pour les utilisateurs ordinaires, le super administrateur le crée lors de la création de la base de données)
userCreate : Date heure de création de l'utilisateur
lastLoginTime : Date de la dernière connexion Heure
laseLoginPlace : String Dernière adresse de connexion

Analyse et conception d'API

L'API dans la description de l'interface ci-dessous fait référence au nom de l'interface, params fait référence aux données entrantes, code fait référence au code d'identification du résultat de la réponse, msg fait référence à la description des informations sur le résultat de la réponse, data fait référence aux données renvoyées avec succès dans le réponse

Interface d'inscription

api: /api/v1/signup  (post)

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

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

msg: 响应返回的信息说明

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

Copier après la connexion

Interface de connexion

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

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

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

msg: 响应返回的信息说明

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

Copier après la connexion

Interface de déconnexion

api: /api/v1/signout  (get)

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

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

data: {}

Copier après la connexion

Afficher l'interface des informations personnelles

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

params: {
    userName: String,
}

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

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

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

Copier après la connexion

Modifier l'interface des informations personnelles

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

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

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

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

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

Copier après la connexion

Implémentation du codage

Remarque : seules des instructions partielles d'implémentation du codage sont fournies pour le contenu complet, veuillez vous rendre sur Egg-API

. Supposons que vous avez initialisé un projet et que l'accord de structure de répertoires du projet est cohérent avec l'accord officiel. Parce que nous voulons utiliser la base de données MongoDB, nous devons d'abord installer egg-mongoose et écrire dans le fichier de configuration :

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

Copier après la connexion

Définir notre fichier de schéma dans le dossier modèle :

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

Copier après la connexion

Définition de la route :

router.post(&#39;/api/v1/signup&#39;, controller.user.signup);

Copier après la connexion

écriture du contrôleur : utilisée pour analyser les entrées de l'utilisateur et renvoyer les résultats correspondants après traitement. Nous pouvons mettre les données obtenues dans le rendu pour le rendu, puis envoyer le résultat rendu au navigateur, ou nous pouvons également attribuer directement les données à ctx.body puis les renvoyer en mode json.

class UserController extends Controller {
    // 登录
    async signin() {
        const { ctx } = this;
        const rule = {
            userName: { type: &#39;string&#39;, required: true, message: &#39;必填项&#39; },
            userPass: { type: &#39;string&#39;, required: true, message: &#39;必填项&#39; },
        };
        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;
    }
}

Copier après la connexion

Écriture de service : utilisée pour écrire la couche de logique métier et peut être réutilisée. Le traitement de données complexes, telles que les informations à afficher, doit être obtenu à partir de la base de données ou faire appel à un service tiers.

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 = &#39;用户信息已更改&#39;;
        res.data = result;
        return res;
    }
}

Copier après la connexion

Une structure d'application de nœud simple est comme ceci, de sorte qu'Egg.js est utilisé pour être responsable du service d'interface. apache php mysql