json-server 使用与配置详解

目录结构及介绍

当你通过克隆或下载的方式获取了 json-server 的代码库之后, 主要关注的是它的执行脚本以及文档说明. 实际上, json-server 并不需要复杂的本地代码集成来运行, 其主要功能均基于命令行工具实现.

不过, 为了提供一个简单且可用的工作环境, 下面是一个典型的 json-server 使用场景下的目录结构:

.
├── db.json       // 数据库文件
└── server.js     // 自定义服务器配置 (可选)

db.json

这是你的假想数据库文件, 内容存储了 json-server 返回的所有数据. 示例中的 db.json 结构可能像这样：

{
  "posts": [
    { "id": "1", "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "id": "1", "body": "some comment", "postId": "1" }
  ],
  "profile": {
    "name": "typicode"
  }
}

server.js

这是一个用于扩展或自定义 json-server 功能的入口点, 例如添加中间件、更改响应头或者处理请求逻辑. 不过通常情况下我们仅使用 json-server 命令来快速建立 RESTAPI.

---

启动文件介绍

虽然 json-server 不需要特定的“启动”文件——因为大部分功能都是通过 CLI 来调用的 ——但是我们可以构造一个简单的 server.js 文件来自定义其行为.

这是一个基本的 server.js 示例, 展示了如何启用 CORS、修改默认端口和添加中间件：

const jsonServer = require('json-server')
const server = jsonServer.create()
const router = jsonServer.router('./db.json')
const middlewares = jsonServer.defaults()

// Set port to 3001 instead of default 3000
const port = process.env.PORT || 3001;

// Custom middleware:
middlewares.push((req, res, next) => {
  console.log(`Received request for ${req.url}`)
  next()
})

// Use json-server's router
server.use(middlewares)
server.use(jsonServer.bodyParser)

server.use(router)

// Listen at custom port
server.listen(port, () => {
  console.log(`Server is running on port ${port}...`)
})

---

配置文件介绍

对于 json-server, 没有一个明确的配置文件, 因为大多数配置是通过 CLI 参数传递的. 然而, 你可以利用一些技巧来达到类似效果.

如果你想让服务器始终监听特定端口, 或者总是启用某些特性(如 CORS), 一种方法是在每次运行 json-server 时带上所需的参数, 如下所示：

# Listening on port 3001 while enabling CORS support
npx json-server --watch ./db.json --port 3001 --cors

然而, 你也可以将这些参数硬编码到前述 server.js 文件中, 达成相同的定制效果.

总结而言, json-server 的配置主要是通过 CLI 参数来定义的, 但也可以借助额外的 JavaScript 文件 (server.js) 来增强其灵活性和功能性.

---

以上就是关于 json-server 项目的结构解析及其核心组件的简要介绍. 无论你是初次接触该工具还是想要深入了解具体细节, 上述指南都应该能给你带来一定帮助.

希望这篇文章能够帮助你更轻松地掌握和应用 json-server, 进一步提升前端开发效率并简化 API 测试流程!