REST API（正常模式）

以下是如何在以下方式中在 任意路由 上构建 REST API 端点

• 将以下内容 POST 或 PUT 到 /pets/cat

  { "cute": true }
  

• 然后，在 /pets/cat 上 GET 将收到

  { "cute": true }
  

• 类似地，您还可以在 /pets/cat 上 DELETE 存储的数据，这将也会收到

  { "cute": true }
  

• 上述请求将在 ./jsonox_data 下的文件设置以下结构

  - pets/
    - cat/
      - index.json
  

• 在根端点 / 上 GET 将显示所有活动端点

  { "active_paths": ["pets/cat"] }
  

您也可以通过在 ./jsonox_data 下创建类似结构的文件来设置自己的 API

- pets/
  - dog/
    - index.json
  - cat/
    - index.json
  - index.json
- toys/
  - doll/
    - index.json

• 然后，在 / 上 GET 将显示活动端点

  { "active_paths": ["pets", "pets/cat", "pets/dog", "toys/doll"] }
  

• 然后您可以在上述端点路径上执行 GET、POST、PUT 和 DELETE。

注意：POST 和 PUT 是可以 互换 的，并且在 此模式 中它们工作得完全一样。这是由于引用的路径是明确指定的。为了在 POST 和 PUT 的情况下允许不同的响应，请考虑使用 只读模式。

只读模式

在此模式下，jsonox 仅读取存储的 json 文件，在 POST/DELETE 的情况下 不创建/删除 它们，与上面解释的正常模式不同。当您只需要模拟 API 响应并且后端不严格遵循 REST 标准时，这很有用。您还可以将 ./jsonox_data 记录在您的版本控制中，以存储 API 响应结构，因为它不会根据此模式中的模拟/测试而更改。

• 首先在 ./jsonox_data 中创建文件

  - pets/
    - dog/
      - get.json
      - post.json
    - cat/
      - get.json
    - get.json
    - delete.json
  - toys/
    - doll/
      - get.json
      - post.json
      - put.json
      - delete.json
  

  • 在 只读 模式下，我们创建类似 get.json、post.json、put.json 和 delete.json 的文件，而不是 index.json。
  • get.json 将包含对该路径的 GET 请求的 响应体。类似地，post.json、put.json 和 delete.json 将分别包含对该路径的 POST、PUT 和 DELETE 请求的 响应体。
  • 因此，根据上述结构
    • /pets 将只有 GET 和 DELETE。
    • /pets/cat 将只有 GET。
    • /pets/dog 将只有 GET 和 POST。
    • /toys/doll 将具有 GET、POST、PUT 和 DELETE 方法。

• 即使您对一个路径执行 DELETE 操作，您创建的文件和路径也不会被删除。

• 如果您在之间更改模式，并在 正常模式 下执行 DELETE 操作，这将仅删除相应路径下的 index.json 文件，而不会删除您创建的其他 get.json、post.json 等文件。

• 类似于正常模式，在 GET 方法上 / 将显示活动端点。

  { "active_paths": ["pets", "pets/cat", "pets/dog", "toys/doll"] }