怎样使用Node.js、TypeScript和Express实现RESTful API服务

莱莱  金牌会员 | 2024-6-2 22:07:10 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 888|帖子 888|积分 2664

Node.js是一个基于 Chrome V8 引擎的 JavaScript 运行情况。Node.js 使用了一个变乱驱动、非阻塞式 I/O 的模型,使其轻量又高效。Express是一个保持最小规模的灵活的 Node.js Web应用步伐开发框架,为Web和移动应用步伐提供一组强大的功能。使用Node.js和Express可以快速的实现一个RESTful API服务。
什么是RESTful API

RESTful API是一种依照 REST（Representational State Transfer，表现层状态转移）架构风格的网络 API 设计，它使用HTTP协议定义的请求方法(GET、POST、PUT、DELETE)来定义对资源的操作。
RESTful API是一种非常流行的API设计风格，它具有以下特点：

  • 使用HTTP协议定义对资源的操作
  • 使用HTTP协议定义的请求方法(GET、POST、PUT、DELETE)来定义对资源的操作
  • 使用JSON作为数据交换格式
  • 使用URL来定义资源
  • 使用HTTP状态码来表现操作结果
怎样使用nodejs和express实现一个RESTful API

在MySQL中创建一个数据库和表
  1. CREATE DATABASE `app`;
  3. CREATE TABLE if not exists user (
  4.     id BIGINT NOT NULL,
  5.     account  varchar(100) DEFAULT '' NOT NULL,
  6.     password varchar(200) DEFAULT '' NOT NULL,
  7.     secret_key varchar(100) DEFAULT '' NOT NULL,
  8.     nick_name varchar(100) DEFAULT '' NOT NULL,
  9.     avatar varchar(300) DEFAULT '' NOT NULL,
  10.     email varchar(100) DEFAULT '' NOT NULL,
  11.     email_verified tinyint(1) DEFAULT 0 NOT NULL,
  12.     phone_number varchar(100) DEFAULT '' NOT NULL,
  13.     phone_numbert_verified tinyint(1) DEFAULT 0 NOT NULL,
  14.     creator_id BIGINT DEFAULT 0 NOT NULL,
  15.     creation_time timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL,
  16.     last_modifier_id BIGINT DEFAULT 0 NOT NULL,
  17.     last_modification_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL,
  18.     CONSTRAINT pk_user PRIMARY KEY (id),
  19.     CONSTRAINT unique_user_email UNIQUE KEY (email),
  20.     CONSTRAINT unique_user_phone UNIQUE KEY (phone_number)
  21. )
  22. ENGINE=InnoDB
  23. DEFAULT CHARSET=utf8mb4
  24. COLLATE=utf8mb4_unicode_ci
复制代码
从GitHub下载项目模板一个基于nodejs、TypeScript和express的web模板

创建User实体类
  1. class User {
  2.     public id!: bigint;
  3.     public account: string;
  4.     public password: string;
  5.     public secret_key: string
  6.     public nick_name: string;
  7.     public avatar: string;
  8.     public email: string;
  9.     public phone_number: string;
  10.     public creator_id: bigint;
  11.     public creation_time!: Date;
  12.     public last_modifier_id!: bigint;
  13.     public last_modification_time!: Date;
  15.     constructor(account: string, password: string, secret_key: string, nick_name: string, avatar: string, email: string,
  16.         phone_number: string, creator_id: bigint) {
  17.         this.account = account;
  18.         this.password = password;
  19.         this.secret_key = secret_key;
  20.         this.nick_name = nick_name;
  21.         this.avatar = avatar;
  22.         this.email = email;
  23.         this.phone_number = phone_number;
  24.         this.creator_id = creator_id;
  25.     }
  26. }
  28. export default User;
复制代码
创建UserService类
  1. import User from "../models/User";
  2. import { connection } from '../utils/db';
  3. import PasswordSecurity from '../utils/password-security';
  4. import { SnowflakeId } from "../utils/snowflakeid";
  6. class UserService {
  8.     public async create(user: User): Promise<User> {
  9.         return new Promise<User>((resolve, reject) => {
  10.             try {
  11.                 const passwordSecurity = new PasswordSecurity();
  12.                 const secret_key = passwordSecurity.createSalt();
  13.                 user.id = SnowflakeId.newId();
  14.                 user.secret_key = secret_key;
  15.                 user.password = passwordSecurity.createHash(user.password, secret_key);
  16.                 user.creation_time = new Date();
  17.                 user.last_modifier_id = user.creator_id;
  18.                 user.last_modification_time = new Date();
  19.                 connection.query('insert into user (id, account, password, secret_key, nick_name, avatar, email, phone_number, creator_id, creation_time, last_modifier_id, last_modification_time)'
  20.                     + 'values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
  21.                     [user.id, user.account, user.password, user.secret_key, user.nick_name, user.avatar, user.email, user.phone_number, user.creator_id, user.creation_time, user.last_modifier_id, user.last_modification_time],
  22.                     function (error: any, result: any) {
  23.                         if (error) {
  24.                             console.log('Error: ' + error.message);
  25.                             reject(error);
  26.                         } else {
  27.                             resolve(user);
  28.                         }
  29.                     });
  30.             } catch (e) {
  31.                 reject(e)
  32.             }
  33.         })
  34.     }
  36.     public async getByAccount(account: string): Promise<User> {
  37.         return new Promise<User>((resolve, reject) => {
  38.             try {
  39.                 connection.query('select * from user where account = ?', [account], function (error: any, result: any) {
  40.                     if (error) {
  41.                         console.log('Error: ' + error.message);
  42.                         reject(error);
  43.                     } else {
  44.                         resolve(result[0]);
  45.                     }
  46.                 });
  47.             } catch (e) {
  48.                 reject(e)
  49.             }
  50.         })
  51.     }
  53.     public async getById(id: number): Promise<User> {
  54.         return new Promise<User>((resolve, reject) => {
  55.             try {
  56.                 connection.query('select * from user where id = ?', [id], function (error: any, result: any) {
  57.                     if (error) {
  58.                         console.log('Error: ' + error.message);
  59.                         reject(error);
  60.                     } else {
  61.                         resolve(result[0]);
  62.                     }
  63.                 })
  64.             } catch (e) {
  65.                 reject(e)
  66.             }
  67.         });
  68.     }
  70.     public async getByEmail(email: string): Promise<User> {
  71.         return new Promise<User>((resolve, reject) => {
  72.             try {
  73.                 connection.query('select * from user where email = ?', [email], function (error: any, result: any) {
  74.                     if (error) {
  75.                         console.log('Error: ' + error.message);
  76.                         reject(error);
  77.                     } else {
  78.                         resolve(result[0]);
  79.                     }
  80.                 })
  81.             } catch (e) {
  82.                 reject(e)
  83.             }
  84.         })
  85.     }
  87.     public async getByPhoneNumber(phone_number: string): Promise<User> {
  88.         return new Promise<User>((resolve, reject) => {
  89.             try {
  90.                 connection.query('select * from user where phone_number = ?', [phone_number], function (error: any, result: any) {
  91.                     if (error) {
  92.                         console.log('Error: ' + error.message);
  93.                         reject(error);
  94.                     } else {
  95.                         resolve(result[0]);
  96.                     }
  97.                 })
  98.             } catch (e) {
  99.                 reject(e)
  100.             }
  101.         })
  102.     }
  104.     public async update(user: User): Promise<User> {
  105.         return new Promise((resolve, reject) => {
  106.             try {
  107.                 connection.query('update user set account = ?, password = ?, secret_key = ?, name = ?, avatar = ?, email = ?, phone_number = ?, creator_id = ?, creation_time = ?, last_modifier_id = ?, last_modification_time = ? where id = ?',
  108.                     [user.account, user.password, user.secret_key, user.nick_name, user.avatar, user.email, user.phone_number, user.last_modifier_id, user.last_modification_time, user.id], function (error, result) {
  109.                         if (error) {
  110.                             console.log('Error: ' + error.message);
  111.                             reject(error)
  112.                         } else {
  113.                             resolve(user);
  114.                         }
  115.                     });
  116.             } catch (e) {
  117.                 reject(e);
  118.             }
  119.         });
  120.     }
  122.     public async delete(id: number): Promise<void> {
  123.         return new Promise<void>((resolve, reject) => {
  124.             try {
  125.                 connection.query('delete from user where id = ?', [id], function (error, result) {
  126.                     if (error) {
  127.                         console.log('Error: ' + error.message);
  128.                         reject(error)
  129.                     } else {
  130.                         resolve();
  131.                     }
  132.                 });
  133.             } catch (e) {
  134.                 reject(e);
  135.             }
  136.         })
  137.     }
  139. }
  141. export default new UserService();
复制代码
创建UserController
  1. import { Request, Response } from 'express';
  2. import User  from '../models/User';
  3. import UserService from '../services/UserService';
  4. import { success, error } from '../utils/json-result'
  5. import { Get, Post, Put, Delete, Controller} from '../utils/routing-controllers'
  7. @Controller('/api/user')
  8. class UserController {
  10.     constructor() { }
  12.     @Post('/')
  13.     public async create(req: Request, res: Response): Promise<any> {
  14.         try {
  15.             var user = new User(
  16.                 req.body.name,
  17.                 req.body.password,
  18.                 req.body.secret_key,
  19.                 req.body.nick_name,
  20.                 req.body.avatar == null || req.body.avatar == undefined ? '' : req.body.avatar,
  21.                 req.body.email,
  22.                 req.body.phone_number,
  23.                 req.body.creator_id == null || req.body.creator_id == undefined ? 0 : req.body.creator_id);
  24.    
  25.             if (user.account == null || user.account == '') {
  26.                 error(res, "用户名不能为空");
  27.                 return;
  28.             }
  29.             if (user.password == null || user.password == '') {
  30.                 error(res, "密码不能为空");
  31.                 return;
  32.             }
  33.             if (user.email == null || user.email == '') {
  34.                 error(res, "邮箱不能为空");
  35.                 return;
  36.             }
  37.             if (user.phone_number == null || user.phone_number == '') {
  38.                 error(res, "手机号不能为空");
  39.                 return;
  40.             }
  41.             var existingUser = await UserService.getByAccount(user.account);
  42.             if (existingUser != null) {
  43.                 error(res, "用户已存在");
  44.                 return
  45.             }
  46.             existingUser = await UserService.getByEmail(user.email);
  47.             if (existingUser != null) {
  48.                 error(res, "邮箱已存在");
  49.                 return;
  50.             }
  51.             existingUser = await UserService.getByPhoneNumber(user.phone_number);
  52.             if (existingUser != null) {
  53.                 error(res, "手机号已存在");
  54.                 return;
  55.             }
  56.             UserService.create(user).then(result => {
  57.                 success(res, result);
  58.             });
  59.         } catch (err: any) {
  60.             console.error(err);
  61.             error(res, err.message);
  62.         }
  63.     }
  65.     @Get('/')
  66.     public get(req: Request, res: Response): any {
  67.         res.send('users');
  68.     }
  70.     @Put('/')
  71.     public update(req: Request, res: Response): any {
  72.         res.send('update user');
  73.         // 处理更新用户的请求
  74.     }
  76.     @Delete('/')
  77.     public delete(req: Request, res: Response): void {
  78.         res.send('delete user');
  79.         // 处理删除用户的请求
  80.     }
  81. }
  83. export default UserController;
复制代码
启动服务
  1. npm start
复制代码
测试
  1. curl -X POST -H "Content-Type: application/json" -d '{"account":"admin","password":"123456","secret_key":"123456","nick_name":"admin","email":"22222@qq.com","phone_number":"13888888888"}' http://localhost:3000/api/user
复制代码
返回结果
  1. {"account":"admin","password":"43ad945a38257858c962d7e703bf090db019e61efda2edd34a48480e8da51b4a12c1f1d04ed06feced130bfa30e76e41f08762ee7e04fe038b2ecd4b90d43c94","secret_key":"b4689647434328c65a18cb7707b74734","nick_name":"admin","avatar":"","email":"22222@qq.com","phone_number":"13888888888","creator_id":0,"id":"11087864288776192","creation_time":"2024-06-02T14:19:12.888Z","last_modifier_id":0,"last_modification_time":"2024-06-02T14:19:12.888Z"}
复制代码
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

莱莱

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

存储 挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表