JSON Templates for Developers — Ready-to-Use Examples for APIs, Config & DevOps
Browse practical JSON templates for REST APIs, configuration files, database schemas, and cloud infrastructure. Copy, customize, and use in your projects. 18 templates with real-world examples.
为什么使用 JSON 模板？
每个开发者都曾多次编写相同的 JSON 结构——API 响应封装、tsconfig.json、Docker Compose 文件。每次，你要么从之前的项目中复制（希望它是正确的），要么从头开始编写（引入微妙的错误）。
模板消除了这种循环。从经过验证的结构开始给你带来四个具体的优势：
- 节省时间。 跳过空文件的问题。模板让你更快进入工作的有趣部分。
- 确保一致性。 当你组织中的每个服务返回相同的 API 封装时，消费者可以编写一个响应处理程序，而不是十个。
- 减少错误。 在 Kubernetes 清单中忘记一个必需字段可能会导致部署失败。模板包含你可能会忘记的字段。
- 更快上手。 新团队成员可以阅读模板，立即理解预期结构，而不是从生产数据中逆向工程。
下面的模板涵盖了现代开发中最常见的 JSON 结构。每个模板都可以在我们的 模板库 中找到，你可以一键复制它们。
API 响应模板
你可以采用的最有影响力的 JSON 模板是一个一致的 API 响应封装。定义一个标准包装，成功时返回 data，失败时返回 error，并为请求跟踪和分页提供 meta，而不是让每个端点返回临时形状。
分页 API 响应
以下是一个遵循封装模式的真实分页响应：
{
"data": [
{ "id": "usr_abc123", "name": "Alice Johnson", "role": "admin" },
{ "id": "usr_def456", "name": "Bob Smith", "role": "member" }
],
"meta": {
"total": 84,
"page": 2,
"per_page": 20,
"total_pages": 5,
"request_id": "req_9f3b7a"
}
}
这个结构允许客户端从 meta 渲染分页控件，而无需猜测。request_id 使调试支持票据变得简单——只需搜索你的日志。
浏览完整模板：REST API 成功响应、REST API 错误响应、分页响应。
配置文件模板
配置文件是大多数 JSON 错误悄然发生的地方。tsconfig.json 中的错误编译器选项不会崩溃——它只会产生微妙错误的输出。从经过验证的模板开始可以避免这种情况。
TypeScript 配置
一个适用于 Next.js 项目的最小但生产就绪的 tsconfig.json：
{
"compilerOptions": {
"target": "ES2017",
"lib": ["dom", "dom.iterable", "esnext"],
"module": "esnext",
"moduleResolution": "bundler",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"jsx": "preserve",
"paths": { "@/*": ["./src/*"] }
},
"include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
"exclude": ["node_modules"]
}
这里的关键选择：strict: true 早期捕获类型错误，moduleResolution: "bundler" 与现代打包工具对齐，@/* 路径别名保持导入整洁。
配置模板：package.json、tsconfig.json、ESLint 配置。
数据库架构模板
无论你是在为开发数据库填充数据，还是为 MongoDB 定义文档结构，拥有一个模板意味着你的团队在应用程序代码的第一行之前就达成了字段名称、类型和默认值的共识。
MongoDB 用户文档
{
"_id": "ObjectId('66a1b2c3d4e5f6a7b8c9d0e1')",
"email": "alice@example.com",
"profile": {
"firstName": "Alice",
"lastName": "Johnson",
"avatar": "https://cdn.example.com/avatars/alice.jpg"
},
"roles": ["admin", "editor"],
"settings": { "theme": "dark", "locale": "en-US" },
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-03-20T14:22:00Z"
}
这个结构将相关字段嵌套在 profile 和 settings 下，以保持顶级文档足够扁平，以便高效索引，同时逻辑上分组相关数据。
数据库模板：MongoDB 架构、Prisma 填充数据。
DevOps 和云模板
基础设施即代码文件是你编写的最容易出错的 JSON 之一。Kubernetes 清单或 CloudFormation 模板中缺少字段可能会导致静默失败，仅在生产中显现。模板为你提供了一个已知良好的起点。
Kubernetes 部署
一个简化的 Kubernetes 部署清单，采用 JSON 格式：
{
"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {
"name": "web-api",
"labels": { "app": "web-api", "env": "production" }
},
"spec": {
"replicas": 3,
"selector": { "matchLabels": { "app": "web-api" } },
"template": {
"metadata": { "labels": { "app": "web-api" } },
"spec": {
"containers": [{
"name": "web-api",
"image": "registry.example.com/web-api:1.4.2",
"ports": [{ "containerPort": 8080 }],
"resources": {
"requests": { "cpu": "250m", "memory": "256Mi" },
"limits": { "cpu": "500m", "memory": "512Mi" }
}
}]
}
}
}
}
默认情况下包含资源请求和限制——跳过它们是共享集群中噪声邻居问题的主要原因。标签遵循标准的 app / env 约定，以便选择器和网络策略开箱即用。
基础设施模板：Docker Compose、Kubernetes 部署、GitHub Actions 工作流。
JWT 负载模板
JSON Web Tokens 以 JSON 负载的形式携带声明。正确获取标准声明至关重要——缺少 exp 声明意味着令牌永不失效，而错误的 iss 会破坏验证。
{
"sub": "usr_abc123",
"iss": "https://auth.example.com",
"aud": "https://api.example.com",
"exp": 1774648800,
"iat": 1774645200,
"nbf": 1774645200,
"roles": ["admin", "editor"],
"email": "alice@example.com"
}
注册的声明（sub、iss、aud、exp、iat、nbf）遵循 RFC 7519。像 roles 和 email 这样的自定义声明应使用简短名称，以保持令牌大小小——JWT 在 HTTP 头中传输，每个字节都很重要。
查看完整模板：JWT 负载。
如何自定义模板
模板是一个起点，而不是成品。以下是将任何模板调整为你项目的实用工作流程：
- 从最接近的模板开始。 选择一个最符合你用例的模板。分页响应模板比通用成功响应更适合搜索端点。
- 重命名和添加字段。 将占位符值更改为实际字段名称。添加你的应用程序所需的特定领域字段。删除不适用的字段。
- 验证结果。 将修改后的 JSON 粘贴到我们的 JSON 验证器 中，以捕获语法错误——在手动编辑时，尾随逗号或缺失引号很容易引入。
- 格式化以提高可读性。 通过 JSON 格式化工具 运行它，以确保在提交到代码库或与团队共享之前保持一致的缩进。
- 用模式锁定它。 对于像 API 响应这样的关键结构，定义一个 JSON Schema，以便未来的更改能够自动验证。
浏览所有模板
本指南中的示例只是一个样本。我们的模板库包括 18 个现成的模板，涵盖 API、配置、数据库、身份验证和云基础设施——每个模板都有逐字段解释和复制到剪贴板的支持。
浏览完整集合： 访问 JSON 模板库 查找适合你技术栈的模板。只需一键复制任何模板，自定义它，并使用我们的 JSON 格式化工具 验证结果。