11、构建理想 API 架构的模块与规划

构建理想 API 架构的模块与规划

1. 文档系统与模块概述

在 API 开发中，文档系统和各种实用模块起着至关重要的作用。有一个自定义文档系统，它与 Swagger 不同，不打算集成到项目中，因此自动生成 JSON 代码可能会更困难一些。不过，该服务器能自动适应 JSON 文件的更新，无需每次更改内容都重启服务器，但仍需找到一种简单的方法来生成 JSON 定义并将其复制到正确的文件夹。

2. 处理超媒体的模块

2.1 Halson 模块

Halson 模块旨在通过提供面向对象的接口简化在响应中添加超媒体的任务。以下是 Halson 模块的基本信息：
| 类别 | 响应中的超媒体 |
| ---- | ---- |
| 当前版本 | 3.0.0 |
| 描述 | 帮助创建符合 HAL 标准的 JSON 对象，可用于 API 响应 |
| 主页 URL | http://github.com/seznam/halson |
| 安装 | $ npm install halson |

以下是一个简单的 Halson 示例代码：

const halson = require('halson');
let embed = halson({
    title: "joyent / node",
    description: "evented I/O for v8 javascript"
})
.addLink('self', '/joyent/node')
.