Google JSON 风格指南

重要说明

展开本指南中的隐藏细节

本风格指南包含许多初始隐藏的细节。它们以左侧的三角形图标标记。请现在点击它。你应该能看到下方出现”好的！”。

好的！现在你知道可以展开要点来获取更多细节了。另外，本文档顶部还有一个”展开全部”按钮。

简介

本风格指南记录了在 Google 构建 JSON API 的指导原则和建议。一般来说，JSON API 应遵循 JSON.org 上的规范。本风格指南对特定情况进行了澄清和标准化，以便 Google 的 JSON API 具有统一的外观和风格。这些指导原则适用于基于 RPC 和基于 REST 的 API 中的 JSON 请求和响应。

定义

在本风格指南中，我们定义以下术语：

property（属性） - JSON 对象中的名称/值对。
property name（属性名） - 属性中的名称（或键）部分。
property value（属性值） - 属性中的值部分。


{
  // 名称/值对合在一起就是一个"属性"。
  "propertyName": "propertyValue"
}

JavaScript 的 number 类型涵盖所有浮点数，这是一个宽泛的定义。在本指南中，number 指 JavaScript 的 number 类型，而 integer 指整数。