Redis 技术文档

本文档旨在帮助用户安装、使用和深入了解 Redis 项目。以下是项目的安装指南、使用说明以及 API 使用文档。

1. 安装指南

Redis 客户端的安装路径遵循特定模式：clients/{language}/github.com/{owner}/{repository}.json。其中 {language} 部分为语言的全名，映射在 languages.json 文件中。

例如，Python 客户端的安装路径为 clients/python/github.com/redis/redis-py.json：

{
    "name": "redis-py",
    "description": "成熟且受支持。目前 Python 的首选方式。",
    "recommended": true
}

2. 项目的使用说明

项目的使用说明主要涉及 Redis 命令的描述。命令描述存储在 commands.json 文件中，该文件是从 Redis 存储库中的命令文件夹自动生成的。

每个命令都有一个 Markdown 文件，其中包含完整的、易于理解的描述。在处理 Markdown 时，需要注意以下几点：

• 文本中，所有命令应以大写形式书写，并在反引号之间。

• 例如：INCR。

• 可以使用一些魔法关键字来命名 Redis 中的常见元素。

• 例如：@multi-bulk-reply。这些关键字将自动扩展并链接到文档的相关部分。

每个命令将有一个描述，以及 RESP2 和 RESP3 返回值。

关于返回值，这些包含在以下文件中：

• resp2_replies.json
• resp3_replies.json

每个文件是一个字典，其中包含一组匹配的键。每个键是一个字符串数组，当处理时，生成 Markdown 内容。以下是一个示例：

{
  ...
  "ACL CAT": [
    "以下之一：",
    "* [数组回复](/docs/reference/protocol-spec#arrays)：一个包含 [大字符串回复](/docs/reference/protocol-spec#bulk-strings) 元素的数组，表示 ACL 类别或类别中的命令。",
    "* [简单错误回复](/docs/reference/protocol-spec#simple-errors)：如果给出无效的类别名称，命令返回错误。"
  ],
  ...
}

重要提示：添加或编辑返回值时，请确保同时编辑这两个文件。

3. 项目 API 使用文档

Redis 命令的 API 使用文档主要涉及命令的描述和返回值。每个命令的描述和返回值都在相应的 Markdown 文件中详细说明。

• 使用大写字母书写命令名称，并在反引号之间。
• 使用魔法关键字来命名常见的 Redis 元素。

以下是一些示例回复类型：

• @simple-string-reply: 简单字符串回复
• @simple-error-reply: 简单错误回复
• @integer-reply: 整数回复
• @bulk-string-reply: 大字符串回复
• @array-reply: 数组回复
• @nil-reply: 空回复
• @null-reply: 空值回复
• @boolean-reply: 布尔回复
• @double-reply: 双精度回复
• @big-number-reply: 大数回复
• @bulk-error-reply: 大错误回复
• @verbatim-string-reply: 逐字字符串回复
• @map-reply: 映射回复
• @set-reply: 集合回复
• @push-reply: 推送回复

4. 项目安装方式

在文档中，您可以使用以下命令来检查拼写和某些轻微的语法错误：

npm install --global spellchecker-cli

然后，您可以运行以下命令来验证拼写：

spellchecker --no-suggestions -f '**/*.md' -l zh-CN -q -d wordlist

任何拼写例外可以添加到 wordlist 文件中。