There may be exceptions to this, especially when referring to numeric property values. The items property name is plural because it represents an array of item objects. An example of this can be seen in the reserved names below. All other property names should be singular.Īrrays usually contain multiple items, and a plural property name reflects this. Services should avoid using these property names for anything other than their defined semantics.Īrray types should have plural property names.
#Google json editor full
a pixel size to the thumbnail url of that size.Ĭertain property names are reserved for consistent use across services.ĭetails about reserved property names, along with the full list, can be found later on in this guide. The "thumbnails" property is a map that maps The "address" property is a sub-object Clients can access these properties using the square bracket notation familiar for maps (for example, result.thumbnails). Map keys may contain any Unicode characters. The keys of a map do not have to obey the naming guidelines for property names. The API documentation should indicate when JSON objects are used as maps. JSON objects and JSON maps look the same at runtime this distinction is relevant to the design of the API. A map (also referred to as an associative array) is a data type with arbitrary key/value pairs that use the keys to access the corresponding values. The property name naming rules do not apply when a JSON object is used as a map. JSON maps can use any Unicode character in key names. "thisPropertyIsAnIdentifier": "identifier value" Here's an example of an object with one property: (for example, result.thisIsAnInstanceVariable). This allows JavaScript clients to access properties using dot notation. These guidelines mirror the guidelines for naming JavaScript identifiers. Reserved JavaScript keywords should be avoided (A list of reserved JavaScript keywords can be found below).Subsequent characters can be a letter, a digit, an underscore, or a dollar sign.The first character must be a letter, an underscore (_) or a dollar sign ($).Property names must be camel-cased, ascii strings.Property names should be meaningful names with defined semantics.Property names must conform to the following guidelines: For example, an address could be represented two ways, but the structured way probably makes more sense for developers: These cases should be carefully considered, and only used if it makes semantic sense. In some cases, such as a collection of properties that represents a single structure, it may make sense to keep the structured hierarchy. Data should not be arbitrarily grouped for convenience. Other value types (like boolean or number) should not be surrounded by double quotes.ĭata should not be arbitrarily grouped for convenience.ĭata elements should be "flattened" in the JSON representation.
Property values of type string must be surrounded by double quotes. All property names must be surrounded by double quotes. If a property requires quotes, double quotes must be used. But don't include comments in your JSON. You may see comments in the examples below, However this is only to clarify the examples. Some of the examples in this style guide include comments. In this guide, number will refer to JavaScript's number type, while integer will refer to integers.Ĭomments should not be included in JSON objects. Javascript's number type encompasses all floating-point numbers, which is a broad designation. The name/value pair together is a "property". property value - the value portion of the property.property name - the name (or key) portion of the property.property - a name/value pair inside a JSON object.These guidelines are applicable to JSON requests and responses in both RPC-based and REST-based APIs.įor the purposes of this style guide, we define the following terms: This style guide clarifies and standardizes specific cases so that JSON APIs from Google have a standard look and feel. In general, JSON APIs should follow the spec found at. This style guide documents guidelines and recommendations for building JSON APIs at Google. Alternatively, there's an "expand all" at the top of this document. Hooray! Now you know you can expand points to get more details.
0 kommentar(er)
