Express Typescript

作者 mindrally97184105b5da無授權條款269 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫5 週前更新

Guidelines for building robust APIs with Express.js and TypeScript, covering middleware patterns, routing, and security best practices

僅含說明Software Development
AI 產生的概覽

以 TypeScript 建構 Express.js API 的規範指南，涵蓋結構、中介軟體、路由、驗證、錯誤、安全與測試。

功能
提供 Express.js 與 TypeScript API 開發的編碼規範參考。內容涵蓋命名與型別慣例、建議的專案目錄結構、應用程式初始化、中介軟體模式、模組化路由、Zod 請求驗證、集中式錯誤處理、Express 型別擴充、安全實務，以及 Jest/supertest 測試。產出的是指引與程式碼範例，而非可直接執行的成品。
適用情境
適用於撰寫、組織或審查 TypeScript 版 Express.js API，並希望維持一致慣例時。也適合在為這類專案加入中介軟體、驗證、錯誤處理、安全標頭或整合測試時參考。
執行需求
未附帶任何指令碼或工具，僅為純說明性參考。範例假定已有 TypeScript 的 Express.js 專案，並提及 Zod、helmet、cors、express-rate-limit、Jest 與 supertest 等套件用於所示模式。

Express TypeScript Development

You are an expert in Express.js and TypeScript development with deep knowledge of building scalable, maintainable APIs.

TypeScript General Guidelines

Basic Principles

  • Use English for all code and documentation
  • Always declare types for variables and functions (parameters and return values)
  • Avoid using any type - create necessary types instead
  • Use JSDoc to document public classes and methods
  • Write concise, maintainable, and technically accurate code
  • Use functional and declarative programming patterns; avoid classes where possible
  • Prefer iteration and modularization to adhere to DRY principles

Nomenclature

  • Use PascalCase for types and interfaces
  • Use camelCase for variables, functions, and methods
  • Use kebab-case for file and directory names
  • Use UPPERCASE for environment variables
  • Use descriptive variable names with auxiliary verbs: isLoading, hasError, canDelete
  • Start each function with a verb

Functions

  • Write short functions with a single purpose
  • Use arrow functions for middleware and handlers
  • Use async/await consistently throughout the codebase
  • Use the RO-RO pattern for multiple parameters

Types and Interfaces

  • Prefer interfaces over types for object shapes
  • Avoid enums; use maps or const objects instead
  • Use Zod for runtime validation with inferred types
  • Use readonly for immutable properties

Express-Specific Guidelines

Project Structure

src/  routes/    {resource}/      index.ts      controller.ts      validators.ts  middleware/    auth.ts    errorHandler.ts    requestLogger.ts    validateRequest.ts  services/    {domain}Service.ts  models/    {entity}.ts  types/    express.d.ts    index.ts  utils/  config/  app.ts  server.ts

Application Setup

typescript
import express, { Express } from 'express';import helmet from 'helmet';import cors from 'cors';import { errorHandler } from './middleware/errorHandler';import { requestLogger } from './middleware/requestLogger';import routes from './routes';
const createApp = (): Express => {  const app = express();
  // Security middleware  app.use(helmet());  app.use(cors());
  // Body parsing  app.use(express.json());  app.use(express.urlencoded({ extended: true }));
  // Request logging  app.use(requestLogger);
  // Routes  app.use('/api', routes);
  // Error handling (must be last)  app.use(errorHandler);
  return app;};
export default createApp;

Middleware Patterns

  • Use middleware for cross-cutting concerns
  • Chain middleware in order of execution
  • Handle errors in dedicated error middleware
typescript
import { Request, Response, NextFunction } from 'express';
// Request logging middlewareconst requestLogger = (req: Request, res: Response, next: NextFunction): void => {  const start = Date.now();
  res.on('finish', () => {    const duration = Date.now() - start;    console.log(`${req.method} ${req.path} ${res.statusCode} ${duration}ms`);  });
  next();};
// Authentication middlewareconst authenticate = async (req: Request, res: Response, next: NextFunction): Promise<void> => {  try {    const token = req.headers.authorization?.split(' ')[1];
    if (!token) {      res.status(401).json({ error: 'No token provided' });      return;    }
    const user = await verifyToken(token);    req.user = user;    next();  } catch (error) {    res.status(401).json({ error: 'Invalid token' });  }};

Routing

  • Organize routes by resource
  • Use Router for modular route definitions
  • Apply middleware at appropriate levels
typescript
import { Router } from 'express';import { authenticate } from '../middleware/auth';import { validateRequest } from '../middleware/validateRequest';import { createUserSchema, updateUserSchema } from './validators';import * as controller from './controller';
const router = Router();
router.get('/', controller.listUsers);router.get('/:id', controller.getUser);router.post('/', validateRequest(createUserSchema), controller.createUser);router.put('/:id', authenticate, validateRequest(updateUserSchema), controller.updateUser);router.delete('/:id', authenticate, controller.deleteUser);
export default router;

Request Validation

  • Validate all incoming requests
  • Use Zod for schema definition and validation
  • Create reusable validation middleware
typescript
import { z } from 'zod';import { Request, Response, NextFunction } from 'express';
const createUserSchema = z.object({  body: z.object({    name: z.string().min(1),    email: z.string().email(),    password: z.string().min(8),  }),});
const validateRequest = (schema: z.ZodSchema) => {  return async (req: Request, res: Response, next: NextFunction): Promise<void> => {    try {      await schema.parseAsync({        body: req.body,        query: req.query,        params: req.params,      });      next();    } catch (error) {      if (error instanceof z.ZodError) {        res.status(400).json({          error: 'Validation failed',          details: error.errors,        });        return;      }      next(error);    }  };};

Error Handling

  • Create custom error classes
  • Use centralized error handler middleware
  • Return consistent error responses
typescript
class AppError extends Error {  constructor(    public statusCode: number,    public message: string,    public code: string = 'INTERNAL_ERROR'  ) {    super(message);    this.name = 'AppError';  }}
class NotFoundError extends AppError {  constructor(resource: string) {    super(404, `${resource} not found`, 'NOT_FOUND');  }}
// Error handler middlewareconst errorHandler = (err: Error, req: Request, res: Response, next: NextFunction): void => {  if (err instanceof AppError) {    res.status(err.statusCode).json({      error: err.code,      message: err.message,    });    return;  }
  console.error(err);  res.status(500).json({    error: 'INTERNAL_ERROR',    message: 'An unexpected error occurred',  });};

TypeScript Extensions

Extend Express types for custom properties:

typescript
// types/express.d.tsimport { User } from '../models/User';
declare global {  namespace Express {    interface Request {      user?: User;      requestId?: string;    }  }}

Security Best Practices

  • Use helmet for security headers
  • Implement rate limiting
  • Sanitize user inputs
  • Use HTTPS in production
  • Implement CORS properly
typescript
import helmet from 'helmet';import rateLimit from 'express-rate-limit';
app.use(helmet());
const limiter = rateLimit({  windowMs: 15 * 60 * 1000, // 15 minutes  max: 100, // limit each IP to 100 requests per windowMs});
app.use('/api', limiter);

Testing

  • Use Jest with supertest for integration tests
  • Test middleware in isolation
  • Mock external dependencies
typescript
import request from 'supertest';import createApp from '../app';
describe('Users API', () => {  const app = createApp();
  it('should create a user', async () => {    const response = await request(app)      .post('/api/users')      .send({ name: 'John', email: '[email protected]', password: 'password123' })      .expect(201);
    expect(response.body).toHaveProperty('id');    expect(response.body.name).toBe('John');  });});

來源與署名

來源：mindrally/skills位於express-typescript提交9718410

授權條款： 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

更多來自 mindrally/skills 的技能

Zustand State Management

mindrally

為 React 與 TypeScript 應用程式中的 Zustand 狀態管理提供設計與使用規範。

Software Development2695 週前更新

Zod Schema Validation

mindrally

關於 Zod 結構描述驗證與 TypeScript 型別推斷的實務指引。

Software Development2695 週前更新

Woocommerce

mindrally

針對 WordPress 與 WooCommerce 外掛開發的指南，涵蓋 PHP 規範、鉤子、安全性與擴充模式。

Software Development2695 週前更新

Wordpress

mindrally

以 PHP 規範、安全實務與測試慣例指導 WordPress 與 WooCommerce 開發。

Software Development2695 週前更新

Websocket Development

mindrally

使用 WebSocket 通訊建構即時應用程式的最佳實務與指引。

Software Development2695 週前更新

Web Development

mindrally

提供 Bootstrap、Django、HTMX 以及一般 Web 最佳實務的 Web 開發指南。

Software Development2695 週前更新

更多Software Development技能

Playground

anthropics

精選

建立自成一體的互動式 HTML 遊樂場，包含控制項、即時預覽與可複製的提示詞輸出。

Software Development37K今天更新

M5 Onboard

anthropics

精選

透過 USB 偵測 M5Stack ESP32 開發板，燒錄 UIFlow 2.0 韌體並安裝 MicroPython 應用程式套件。

Software Development37K今天更新

Cardputer Buddy

anthropics

精選

指導迭代 Cardputer-Adv 的 MicroPython 應用程式套件：新增應用程式、透過 USB 序列埠推送檔案、查看日誌並執行 REPL 指令。

Software Development37K今天更新

Web Design Guidelines

vercel-labs

精選

依據從遠端來源取得的 Web Interface Guidelines 審查 UI 程式碼，並以 file:line 形式回報問題。

Software Development32K5 週前更新

Vercel React Native Skills

vercel-labs

精選

React Native 與 Expo 最佳實務規則，涵蓋清單效能、動畫、導覽、UI 模式、狀態與 monorepo 設定。

Software Development32K5 週前更新

Vercel React Best Practices

vercel-labs

精選

Vercel 的 React 與 Next.js 效能指南，以 70 條規則的形式用於撰寫、審查與重構程式碼。

Software Development32K5 週前更新