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周前更新