Coder Social home page Coder Social logo

under_score for JSON keys? about api-standards HOT 6 CLOSED

18f avatar 18f commented on June 18, 2024 4
under_score for JSON keys?

from api-standards.

Comments (6)

delfuego avatar delfuego commented on June 18, 2024 2

I agree, but mostly because I don't know where "JSON uses under_score" comes from — I've never heard that as a given.

from api-standards.

edsu avatar edsu commented on June 18, 2024

I think it comes largely from the Perl, Ruby and Python communities that generally prefer under_score to camelCase. Those are my people, but I recognize that there are other ways of doing it, and maybe it isn't really the place for this document to say do it one way? If there was some other JSON effort pushing for this standardization I would be happy to see it.

from api-standards.

konklone avatar konklone commented on June 18, 2024

I'd prefer to be agnostic and to just recommend consistency, than to recommend camelCase. JSON emerged from JavaScript, but it's used now as a generic transport format with ubiquitous support in many languages.

Ruby and Python drive a lot of 18F's work, and to a lesser (but real) degree, Node. In Node, things do lean more camelCase, but even there it's not as absolute as in client-side JavaScript. If other 18Fers would prefer to remove the under_score recommendation, we can definitely do that.

from api-standards.

mlissner avatar mlissner commented on June 18, 2024

FWIW, we've thought a lot about this and came to the conclusion that underscore was the way to go even in our client-side Javascript (we use Python on the backend). It's not the recommended way of doing things, but keeping things consistent has been nice. As an extension of this, our XML and JSON also have underscores. So +1 for underscores, FWIW.

from api-standards.

edsu avatar edsu commented on June 18, 2024

I agree with @mlissner and @konklone: consistency is what is important. Encouraging API designers to consciously pick under_score or camelCase and stick to it seems like the right way to go.

from api-standards.

jessieay avatar jessieay commented on June 18, 2024

I tend to use under_score keys because Ruby has infiltrated by brain, but there are also good arguments for using CamelCase. I am on board with recommending consistency over underscore so I opened #64

from api-standards.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.