如何使用Node.js、TypeScript和Express實現RESTful API服務

来源:https://www.cnblogs.com/huangmingji/p/18227760
-Advertisement-
Play Games

Node.js是一個基於 Chrome V8 引擎的 JavaScript 運行環境。Node.js 使用了一個事件驅動、非阻塞式 I/O 的模型,使其輕量又高效。Express是一個保持最小規模的靈活的 Node.js Web應用程式開發框架,為Web和移動應用程式提供一組強大的功能。使用Node ...


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設計風格，它具有以下特點：

  1. 使用HTTP協議定義對資源的操作
  2. 使用HTTP協議定義的請求方法(GET、POST、PUT、DELETE)來定義對資源的操作
  3. 使用JSON作為數據交換格式
  4. 使用URL來定義資源
  5. 使用HTTP狀態碼來表示操作結果

如何使用nodejs和express實現一個RESTful API

在MySQL中創建一個資料庫和表

CREATE DATABASE `app`;

CREATE TABLE if not exists user (
    id BIGINT NOT NULL,
    account  varchar(100) DEFAULT '' NOT NULL,
    password varchar(200) DEFAULT '' NOT NULL,
    secret_key varchar(100) DEFAULT '' NOT NULL,
    nick_name varchar(100) DEFAULT '' NOT NULL,
    avatar varchar(300) DEFAULT '' NOT NULL,
    email varchar(100) DEFAULT '' NOT NULL,
    email_verified tinyint(1) DEFAULT 0 NOT NULL,
    phone_number varchar(100) DEFAULT '' NOT NULL,
    phone_numbert_verified tinyint(1) DEFAULT 0 NOT NULL,
    creator_id BIGINT DEFAULT 0 NOT NULL,
    creation_time timestamp DEFAULT CURRENT_TIMESTAMP NOT NULL,
    last_modifier_id BIGINT DEFAULT 0 NOT NULL,
    last_modification_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL,
    CONSTRAINT pk_user PRIMARY KEY (id),
    CONSTRAINT unique_user_email UNIQUE KEY (email),
    CONSTRAINT unique_user_phone UNIQUE KEY (phone_number)
)
ENGINE=InnoDB
DEFAULT CHARSET=utf8mb4
COLLATE=utf8mb4_unicode_ci

從GitHub下載項目模板一個基於nodejs、TypeScript和express的web模板

創建User實體類

class User {
    public id!: bigint;
    public account: string;
    public password: string;
    public secret_key: string
    public nick_name: string;
    public avatar: string;
    public email: string;
    public phone_number: string;
    public creator_id: bigint;
    public creation_time!: Date;
    public last_modifier_id!: bigint;
    public last_modification_time!: Date;

    constructor(account: string, password: string, secret_key: string, nick_name: string, avatar: string, email: string,
        phone_number: string, creator_id: bigint) {
        this.account = account;
        this.password = password;
        this.secret_key = secret_key;
        this.nick_name = nick_name;
        this.avatar = avatar;
        this.email = email;
        this.phone_number = phone_number;
        this.creator_id = creator_id;
    }
}

export default User;

創建UserService類

import User from "../models/User";
import { connection } from '../utils/db';
import PasswordSecurity from '../utils/password-security';
import { SnowflakeId } from "../utils/snowflakeid";

class UserService {

    public async create(user: User): Promise<User> {
        return new Promise<User>((resolve, reject) => {
            try {
                const passwordSecurity = new PasswordSecurity();
                const secret_key = passwordSecurity.createSalt();
                user.id = SnowflakeId.newId();
                user.secret_key = secret_key;
                user.password = passwordSecurity.createHash(user.password, secret_key);
                user.creation_time = new Date();
                user.last_modifier_id = user.creator_id;
                user.last_modification_time = new Date();
                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)'
                    + 'values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)',
                    [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],
                    function (error: any, result: any) {
                        if (error) {
                            console.log('Error: ' + error.message);
                            reject(error);
                        } else {
                            resolve(user);
                        }
                    });
            } catch (e) {
                reject(e)
            }
        })
    }

    public async getByAccount(account: string): Promise<User> {
        return new Promise<User>((resolve, reject) => {
            try {
                connection.query('select * from user where account = ?', [account], function (error: any, result: any) {
                    if (error) {
                        console.log('Error: ' + error.message);
                        reject(error);
                    } else {
                        resolve(result[0]);
                    }
                });
            } catch (e) {
                reject(e)
            }
        })
    }

    public async getById(id: number): Promise<User> {
        return new Promise<User>((resolve, reject) => {
            try {
                connection.query('select * from user where id = ?', [id], function (error: any, result: any) {
                    if (error) {
                        console.log('Error: ' + error.message);
                        reject(error);
                    } else {
                        resolve(result[0]);
                    }
                })
            } catch (e) {
                reject(e)
            }
        });
    }

    public async getByEmail(email: string): Promise<User> {
        return new Promise<User>((resolve, reject) => {
            try {
                connection.query('select * from user where email = ?', [email], function (error: any, result: any) {
                    if (error) {
                        console.log('Error: ' + error.message);
                        reject(error);
                    } else {
                        resolve(result[0]);
                    }
                })
            } catch (e) {
                reject(e)
            }
        })
    }

    public async getByPhoneNumber(phone_number: string): Promise<User> {
        return new Promise<User>((resolve, reject) => {
            try {
                connection.query('select * from user where phone_number = ?', [phone_number], function (error: any, result: any) {
                    if (error) {
                        console.log('Error: ' + error.message);
                        reject(error);
                    } else {
                        resolve(result[0]);
                    }
                })
            } catch (e) {
                reject(e)
            }
        })
    }

    public async update(user: User): Promise<User> {
        return new Promise((resolve, reject) => {
            try {
                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 = ?',
                    [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) {
                        if (error) {
                            console.log('Error: ' + error.message);
                            reject(error)
                        } else {
                            resolve(user);
                        }
                    });
            } catch (e) {
                reject(e);
            }
        });
    }

    public async delete(id: number): Promise<void> {
        return new Promise<void>((resolve, reject) => {
            try {
                connection.query('delete from user where id = ?', [id], function (error, result) {
                    if (error) {
                        console.log('Error: ' + error.message);
                        reject(error)
                    } else {
                        resolve();
                    }
                });
            } catch (e) {
                reject(e);
            }
        })
    }

}

export default new UserService();

創建UserController

import { Request, Response } from 'express';
import User  from '../models/User';
import UserService from '../services/UserService';
import { success, error } from '../utils/json-result'
import { Get, Post, Put, Delete, Controller} from '../utils/routing-controllers'

@Controller('/api/user')
class UserController {

    constructor() { }

    @Post('/')
    public async create(req: Request, res: Response): Promise<any> {
        try {
            var user = new User(
                req.body.name, 
                req.body.password, 
                req.body.secret_key, 
                req.body.nick_name, 
                req.body.avatar == null || req.body.avatar == undefined ? '' : req.body.avatar, 
                req.body.email,
                req.body.phone_number, 
                req.body.creator_id == null || req.body.creator_id == undefined ? 0 : req.body.creator_id);
    
            if (user.account == null || user.account == '') {
                error(res, "用戶名不能為空");
                return;
            }
            if (user.password == null || user.password == '') {
                error(res, "密碼不能為空");
                return;
            }
            if (user.email == null || user.email == '') {
                error(res, "郵箱不能為空");
                return;
            }
            if (user.phone_number == null || user.phone_number == '') {
                error(res, "手機號不能為空");
                return;
            }
            var existingUser = await UserService.getByAccount(user.account);
            if (existingUser != null) {
                error(res, "用戶已存在");
                return
            }
            existingUser = await UserService.getByEmail(user.email);
            if (existingUser != null) {
                error(res, "郵箱已存在");
                return;
            }
            existingUser = await UserService.getByPhoneNumber(user.phone_number);
            if (existingUser != null) {
                error(res, "手機號已存在");
                return;
            }
            UserService.create(user).then(result => {
                success(res, result);
            });
        } catch (err: any) {
            console.error(err);
            error(res, err.message);
        }
    }

    @Get('/')
    public get(req: Request, res: Response): any {
        res.send('users');
    }

    @Put('/')
    public update(req: Request, res: Response): any {
        res.send('update user');
        // 處理更新用戶的請求
    }

    @Delete('/')
    public delete(req: Request, res: Response): void {
        res.send('delete user');
        // 處理刪除用戶的請求
    }
}

export default UserController;

啟動服務

npm start

測試

curl -X POST -H "Content-Type: application/json" -d '{"account":"admin","password":"123456","secret_key":"123456","nick_name":"admin","email":"[email protected]","phone_number":"13888888888"}' http://localhost:3000/api/user

返回結果

{"account":"admin","password":"43ad945a38257858c962d7e703bf090db019e61efda2edd34a48480e8da51b4a12c1f1d04ed06feced130bfa30e76e41f08762ee7e04fe038b2ecd4b90d43c94","secret_key":"b4689647434328c65a18cb7707b74734","nick_name":"admin","avatar":"","email":"[email protected]","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"}

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Python 將Word/ Exce/ PDF/ PPT文檔轉為OFD文檔
    OFD（Open Fixed-layout Document ）是我國自主制定的一種開放版式文件格式標準。OFD文檔具有不易被篡改、格式獨立、版式固定等特點，目前常用於政府公文、金融、電子發票等領域。 如果想要通過Python將Office文檔（如Word、Excel或PowerPoint）及PDF ...
  • DevOps全面綜述：從概念到實踐
    這篇文章詳盡介紹了DevOps的背景、核心實踐、工具和技術，探討了團隊協作、文化建設及組織變革，旨在幫助企業高效實現持續交付和創新。 關註作者，分享互聯網架構、雲服務技術的全維度知識。作者擁有10+年互聯網服務架構、AI產品研發經驗、團隊管理經驗，同濟本復旦碩博，復旦機器人智能實驗室成員，阿裡雲認證 ...
  • 一文帶你理解透MyBatis源碼
    本文分享自華為雲社區《一文徹底吃透MyBatis源碼！！》，作者：冰 河。 寫在前面 隨著互聯網的發展，越來越多的公司摒棄了Hibernate，而選擇擁抱了MyBatis。而且，很多大廠在面試的時候喜歡問MyBatis底層的原理和源碼實現。總之，MyBatis幾乎成為了Java開發人員必須深入掌握的 ...
  • 為什麼以及如何要進行架構設計權衡？
    對於“軟體架構”這個詞有很多定義和含義。而且，“軟體開發”、“軟體設計”和“軟體架構”這三個概念之間存在相當大的重疊，它們在許多方面相互交融。 從核心上看，可以將軟體架構視為在構建應用程式時，對不同選擇進行權衡的學科。 1 為什麼需要權衡以及我們為什麼在意？ 我們在構建軟體時必須進行權衡的原因，與其 ...
  • Go 語言學習筆記之數組與切片
    大家好，我是碼農先森。 數組與切片的區別 在 Go 語言中，數組和切片是兩種不同的數據結構，它們之間有以下主要區別。 參數長度： 數組（Array）：數組的長度是固定的，在創建時就需要指定數組的長度，無法動態改變；只有長度信息，通過 len() 函數獲取。 切片（Slice）：切片是對數組的一個引用 ...
  • 《最少必要面試題》第一版
    《最少必要面試題》第一版 相信大家都會有種及眼熟又陌生的感覺、看過可能在短暫的面試後又馬上忘記了。JavaPub 在這裡整理這些容易忘記的重點知識及 解答，建議收藏，經常溫習查閱。 點擊線上閱讀《最少必要面試題》 更多 作者：JavaPub2024 目錄緩存1. 什麼是緩存？2. 為什麼要用緩存？3 ...
  • 【爬蟲軟體】2024小紅書對標賬號作品批量採集！
    一、背景介紹 1.1 爬取目標 用python開發的爬蟲採集軟體，可自動按指定博主抓取該博主已發佈筆記。 為什麼有了源碼還開發界面軟體呢？方便不懂編程代碼的小白用戶使用，無需安裝python，無需改代碼，雙擊打開即用！ 軟體界面截圖: 爬取結果截圖： 結果截圖1: 結果截圖2: 結果截圖3: 以上。 ...
  • Java Lambda表達式
    Lambda表達式 Lambda表達式,也可以稱為閉包,是Java 8發佈的最重要新特性 Lambda允許把函數作為一個方法的參數(函數作為參數傳遞進方法中) 使用Lambda表達式可以使代碼變的更加簡潔緊湊 語法: (parameter) -> expression (parameter) -> ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類