705

Is there a standard on JSON naming?
I see most examples using all lower case separated by underscore, aka snake_case, but can it be used PascalCase or camelCase as well?

11
  • 48
    I was curious what some industry leaders chose. Twitter and Facebook API's use snake_case while Microsoft and Google use camelCase. Commented May 2, 2016 at 21:38
  • 16
    @Justin that is because Twitter is using Ruby and Facebook is using PHP. Ruby and PHP are into snake_case. Microsoft and Google are well using C/.NET and Java respectively. Oh that's right .Net and Java are into camelCase maybe. It's all about the conventions of the programming languages Commented Dec 12, 2017 at 22:56
  • 3
    There is no standard, but the convention seems to be to use the standard of the technology of the receiving system. Commented Feb 8, 2019 at 11:45
  • 4
    All are correct there is no stringent convention for names/keys in JSON. Though, I highly recommend to avoid kebab-case as it cannot be accessed by dot(.) notation in javascript and has to be accessed using array[] notation which I think is tedious. Commented Jul 5, 2019 at 2:16
  • 3
    From my experience for JSON snake_case is more appropriate. 1. Using camel case you lose the casing in many databases or may need special handling. For instance, Cassandra CQL is case-insensitive. If you were to map this JSON to DB records, makes sense to use snake_sase. 2. Hyphen is considered a special char in many languages and not accepted in names. Commented Jul 13, 2021 at 7:40

7 Answers 7

644

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.

Sign up to request clarification or add additional context in comments.

8 Comments

Can someone explain why and when you would use an underscore to prefix a property name? A reference would be useful, not just an opinion.
@MaduraPradeep ProperCase is also camel case, sometimes called UpperCamelCase. en.wikipedia.org/wiki/Camel_case
citing Google is not a propper answer. they just support a certain convention/guideline and it looks to be java making sense as they are pretty java oriented.
This does not answer the question. This is just one of many style guides, and there are many other style guides mandating either snake_case, PascalCase and camelCase. Citing your own team's preference is irrelevant. Abel's answer below is a much better answer to the question.
|
497

ECMA-404

The JSON syntax does not impose any restrictions on the strings used as names,...

There is no standard naming of keys in JSON and that camelCase or snake_case should work fine.

TL;DR

Here is a rule-of-a-thumb which I think most of the developers use.

Technology stack Naming convention Reason/guide
Python » JSON » Python snake_case Unanimous
Python » JSON » PHP snake_case Unanimous
Python » JSON » Java snake_case or camelCase Lean on where the business logic resides. Take advantage of the extrinsic style of Java.
Python » JSON » back‑end JavaScript snake_case or camelCase Lean on where the business logic resides.
Python » JSON » front‑end JavaScript snake_case Screw the front-end anyway
Python » JSON » you do not know snake_case Screw the parser anyway
PHP » JSON » Python snake_case Unanimous
PHP » JSON » PHP snake_case Unanimous
PHP » JSON » Java snake_case or camelCase Lean on where the business logic resides. Take advantage of the extrinsic style of Java.
PHP » JSON » back‑end JavaScript snake_case or camelCase Lean on where the business logic resides.
PHP » JSON » front‑end JavaScript snake_case Screw the front-end anyway
PHP » JSON » you do not know snake_case Screw the parser anyway
Java » JSON » Python camelCase or snake_case Lean on where the business logic resides. Take advantage of the extrinsic style of Java.
Java » JSON » PHP camelCase or snake_case Lean on where the business logic resides. Take advantage of the extrinsic style of Java.
Java » JSON » Java camelCase Unanimous
Java » JSON » JavaScript camelCase Unanimous
Java » JSON » you do not know camelCase Screw the parser anyway
back‑end JavaScript » JSON » Python camelCase or snake_case Lean on where the business logic resides.
front‑end JavaScript » JSON » Python snake_case Screw the front-end anyway
back‑end JavaScript » JSON » PHP camelCase or snake_case Lean on where the business logic resides.
front‑end JavaScript » JSON » PHP snake_case Screw the front-end anyway
JavaScript » JSON » Java camelCase Unanimous
JavaScript » JSON » JavaScript camelCase Original
JavaScript » JSON » you do not know camelCase Screw the parser anyway

Driving factors

Imposing a naming convention is very confusing because JSON alone does not impose a standard. However, this can easily be figured out if you break it down into components.

JSON generator

Programming language Naming convention
Python snake_case
PHP snake_case
Java camelCase
JavaScript camelCase

JSON parser

Programming language Naming convention
Python snake_case
PHP snake_case
Java camelCase
JavaScript camelCase

Bulk of business logic

You have to decide which side has the heavier business logic, is it the JSON generator side or the JSON parser side?

Natural belongingness

Programming language Natural belongingness
Python intrinsic
PHP intrinsic
Java extrinsic
JavaScript intrinsic

Intrinsic - Programming language where JSON is accessed naturally similar to accessing native objects and arrays.

Extrinsic - Programming language where JSON is accessed differently than accessing native objects and arrays. Below is an example of Java's com.google.gson package:

/**
 * Using a method to access a property instead of using the standard 'dot.syntax'
 */
JsonElement.getAsString("snake_cased_key");

Some actual implementations

Conclusions

Choosing the right JSON naming convention for your JSON implementation depends on your technology stack. There are cases where you can use snake_case, camelCase, or any other naming convention.

Another thing to consider is the weight to be put on the JSON-generator vs the JSON-parser and/or the front-end JavaScript. In general, more weight should be put on business logic side.

Also, if the JSON-parser side is unknown then you can declare what ever can work for you.

Personal opinion

I know we are not meant to do opinions here in SO but it is the best way to distinguish us humans from AIs. My take is that we all should at least favor snake_case. The reason is that if you take into account the database storage aspect, huge chance is that the data are stored in snake_case keys/columns.

20 Comments

"Person":isn't camelCase :)
I disagree with these ideas, simply because Python backend > Java frontend should be camelCase, but then you add Python frontend and you have compromised backend and one frontend. It should be how backend has it by "standard". Frontend parsers have it easier to adapt anyway
My concern here is that there is reference to "your technology" stack. A producer of JSON especially if to served up by a HTTP server should have no knowledge of who or what is consuming it, or for what reasons. If JSON is used as a method of communication between many producers and consumers, then the technology stack of the producer should not be a consideration.
@RobbieWareham I somehow agree on that. The thing here is that "by standards" there isnt an official naming convention. So with that, maybe one should opt for "by de facto" which is to look at the technology stack. I think looking into the technology stack is the best way to go. Take a look at facebook, did they historically honor JavaScript and use snakeCase? Nah! They chose to stick with PHP's snake_case.
While I somewhat agree with your answer. I'm not comfortable with choice reasons being "make sense" and "screw front end". Big reasons why back-end naming conventions have more weight in JSON naming style is because it naturally tend to create more than read these structs, and also matching naming style cuts A LOT of silly mapping code, making things simpler in a delicate piece of the app. Front-end frameworks and libs are more flexible in that aspect and mistakes would "just" result in a UI bug.
|
358

There is no SINGLE standard, but I have seen 3 styles you mention ("Pascal/Microsoft", "Java" (camelCase) and "C" (underscores, snake_case)) -- as well as at least one more, kebab-case like longer-name).

It mostly seems to depend on what background developers of the service in question had; those with c/c++ background (or languages that adopt similar naming, which includes many scripting languages, ruby etc) often choose underscore variant; and rest similarly (Java vs .NET). Jackson library that was mentioned, for example, assumes Java bean naming convention (camelCase)

UPDATE: my definition of "standard" is a SINGLE convention. So while one could claim "yes, there are many standards", to me there are multiple Naming Conventions, none of which is "The" standard overall. One of them could be considered the standard for specific platform, but given that JSON is used for interoperability between platforms that may or may not make much sense.

8 Comments

Sticking with the background of the devs is important, but JSON sticks with the Javascript standard. Your first statement isn't quite correct. But definately stick with the naming conventions of your team.
It would be interesting to see some statistics, as there is constant friction between people who claim connection between JSON and Javascript (beyond just historical heritage), and those who think there is little currently that connects JSON to Javascript. I belong to the latter camp. But I would be interested in knowing relative usage patterns.
@StaxMan C# uses PascalCase in the majority of cases, not camelCase.
@StaxMan would you consider updating your answer to include mention of Googles Style Guide
@mannedear nothing in JSON spec prevents that so sure. It could be considered yet another naming convention. :)
|
25

Notably for me on NodeJS, if I'm working with databases and my field names are underscore separated, I also use them in the struct keys.

This is because db fields have a lot of acronyms/abbreviations so something like appSNSInterfaceRRTest looks a bit messy but app_sns_interface_rr_test is nicer.

In Javascript variables are all camelCase and class names (constructors) are ProperCase, so you'd see something like

var devTask = {
        task_id: 120,
        store_id: 2118,
        task_name: 'generalLedger'
    };

or

generalLedgerTask = new GeneralLedgerTask( devTask );

And of course in JSON keys/strings are wrapped in double quotes, but then you just use the JSON.stringify and pass in JS objects, so don't need to worry about that.

I struggled with this a bit until I found this happy medium between JSON and JS naming conventions.

2 Comments

same here. Receiving JSON with snake_case at Android client looks awkward !! Also database doesn't differentiate casing for the column names, so snake_case seems to be best for database.
@mythicalcoder JSON in Java is not intrinsic in its core. Java only uses external packages for parsing Java e.g. org.json , gson. Recieving snake_case data doesn't hurt that much like so... JSONObject.get('snake_case_key_here')
8

Seems that there's enough variation that people go out of their way to allow conversion from all conventions to others: http://www.cowtowncoder.com/blog/archives/cat_json.html

Notably, the mentioned Jackson JSON parser prefers bean_naming.

1 Comment

Minor correction: Jackson defaults to Java bean naming convention, which is (lower) Camel Case, like beanNaming.
0

I think that there isn't a official naming convention to JSON, but you can follow some industry leaders to see how it is working.

Google, which is one of the biggest IT company of the world, has a JSON style guide: https://google.github.io/styleguide/jsoncstyleguide.xml

Taking advantage, you can find other styles guide, which Google defines, here: https://github.com/google/styleguide

Comments

0

As others have stated there is no standard so you should choose one yourself. Here are a couple of things to consider when doing so:

  1. If you are using JavaScript to consume JSON then using the same naming convention for properties in both will provide visual consistency and possibly some opportunities for cleaner code re-use.

  2. A small reason to avoid kebab-case is that the hyphens may clash visually with - characters that appear in values.

    {
      "bank-balance": -10
    }
    

3 Comments

snake_case uses underscores, not dashes.
a reason to avoid kebab-case is that they're not treated as one word. so you cannot e.g. double click with the mouse to select the entire key.
The use of kebab-case makes property manipulation in JavaScript more verbose and less readable.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.