Scaffolding APIs

Scaffolding creates a consistent starting point so every new service has the same layout, scripts, and quality gates.

Recipe

Quick-reference recipe card - copy-paste ready.

mkdir orders-api && cd orders-api
npm init -y
npm install express@5
npm install -D typescript@5.6 tsx @types/node @types/express eslint
npx --yes @nestjs/cli new orders-api --package-manager npm --strict

When to reach for this:

• Bootstrapping a greenfield HTTP service.
• Standardizing org-wide folder layout and CI hooks.
• Avoiding copy-paste from an old repo with stale dependencies.

Working Example

# 1. Org template (preferred for teams)
git clone git@github.com:acme/node-api-template.git billing-api
cd billing-api
rm -rf .git && git init
npm ci
 
# 2. Or minimal manual scaffold
npm init -y
npm pkg set type=module
npm pkg set scripts.dev="tsx watch src/server.ts"
npm pkg set scripts.build="tsc -p tsconfig.build.json"
npm pkg set scripts.start="node dist/server.js"
npm pkg set scripts.test="node --import tsx --test"
npm install express@5
npm install -D typescript@5.6 tsx @types/node @types/express
npx tsc --init --module NodeNext --moduleResolution NodeNext --strict
mkdir -p src test

// src/server.ts
import express from "express";
 
export function createApp() {
  const app = express();
  app.use(express.json());
  app.get("/health", (_req, res) => res.json({ ok: true }));
  return app;
}
 
if (import.meta.url === `file://${process.argv[1]}`) {
  createApp().listen(3000);
}

What this demonstrates:

• Template repos encode org decisions (ESLint, Docker, CI) once.
• npm pkg set scripts without hand-editing JSON.
• createApp() export enables Supertest integration tests from day one.

Deep Dive

How It Works

• npm init creates package.json; frameworks add routing, DI, and conventions.
• NestJS CLI generates modules, controllers, and nest-cli.json build graph.
• Fastify CLI and Express have lighter scaffolds - you bring more structure yourself.
• Template repos should run npm ci && npm test in CI to prove they work.

Framework CLIs

TypeScript Notes

npm install -D typescript@5.6 tsx
# tsconfig: "module": "NodeNext", "strict": true

• Scaffold with the same module settings you use in production builds.
• Add test/ and a sample test in the template so CI is never empty.

Gotchas

• Stale template dependencies - New services inherit old Express 4 pins. Fix: Renovate on the template repo; version template releases.
• CLI defaults wrong package manager - Nest prompts for yarn unless you pass --package-manager npm. Fix: script the flags in docs.
• Missing createApp export - Hard to integration-test servers that only call listen() at import. Fix: export factory; start server in if (main) guard.
• Copying .env from old projects - Secrets leak into git history. Fix: only .env.example in templates.
• Over-generated Nest structure - Default CLI creates more folders than a small API needs. Fix: prune modules or use a slim internal template.

Alternatives

FAQs

Related

• Project Setup Basics - standard folder layout
• Turborepo for Node - monorepo scaffold next step
• Nx for Node Backends - generator-based setup

Stack versions: This page was written for Node.js 24.18.0 (Active LTS), npm 10+, TypeScript 5.6+, Express 5, Fastify 5, and NestJS 11.