JSON Naming Convention (snake_case, camelCase or PascalCase) [closed]

by

In this document Google JSON Style Guide (recommendations for building JSON APIs at Google),

It recommends that:

  1. Property names must be camelCased, ASCII strings.

  2. The first character must be a letter, an underscore (_), or a dollar sign ($).

Example:

{
  "thisPropertyIsAnIdentifier": "identifier value"
}

My team consistently follows this convention when building REST APIs. There are some reasons:

  • First, the JSON convention should be independent of the programming languages because we want our APIs to be consistent doesn’t matter whether there are some APIs implemented using a camelCase language (e.g. Java), some others using snake_case language (e.g. Python).
  • Also, most of our clients are webapp so camelCase is preferred
  • If the client prefers snake_case, it still can easily convert data between snake_case and camelCase (with the help of libraries)

But I agree that if all the applications use the same type of language (e.g. snake_case), the JSON convention should also follow.

More Related Contents:

  1. What is the naming convention in Python for variables and functions?
  2. What is JSON and what is it used for?
  3. How do I consume the JSON POST data in an Express application
  4. Convert Dictionary to JSON in Swift
  5. Is there a query language for JSON?
  6. Getting imported json data into a data frame
  7. How to parse JSON in Scala using standard Scala classes?
  8. JSON to TypeScript class instance? [duplicate]
  9. json.Unmarshal returning blank structure
  10. Nested ng-repeat
  11. How to import JSON File into a TypeScript file?
  12. Unix command-line JSON parser? [closed]
  13. Disable Hypertext Application Language (HAL) in JSON?
  14. how to parse a JSON String with jq (or other alternatives)?
  15. Unmarshaling json in Go: required field?
  16. UnicodeDecodeError: ‘utf8’ codec can’t decode byte 0x80 in position 3131: invalid start byte
  17. Spring Security and JSON Authentication
  18. Standard way of referencing an object by identity (for, eg, circular references)?
  19. Json handling in ROBOT
  20. Exporting JSON to environment variables
  21. How to generate JSON response from JSF?
  22. How to output Django queryset as JSON?
  23. Flutter Registration with API
  24. Get IIS6 to serve JSON files (inc. POST,GET)?
  25. Escaping characters in bash (for JSON)
  26. How to save an array as a json file in Swift?
  27. Converting object to an encodable object failed
  28. node.js readfile error with utf8 encoded file on windows
  29. Escaping Regex to get Valid JSON
  30. passing JSON data to a Spring MVC controller

Leave a Comment