Creating an API guideline, jsonapi vs json.org?

[ingo]

Hi!

I would like to formalize and align some of our API:s according to specific guidelines.
When creating my Guidelines, is there a difference if I use jsonapi.org as my reference compared to json.org as a reference ? or is jsonapi.org coming from json.org ?

Best regards,i

[steveklabnik]

@ingo

I would like to formalize and align some of our API:s according to specific guidelines.

Are they compliant with our spec or not?

@ingo

or is jsonapi.org coming from json.org ?

As it says at the start of the spec:

JSON API documents are defined in JavaScript Object Notation (JSON)
[RFC7159].

That is, JSON API is a superset of JSON.

[ingo]

Thank you for your reply Steve.

1. To answer your first question, I guess I would like to be compliant to RFC7159 and use jsonapi.org to get to that point. So I think I would like my API:s to be compliant with your spec, that depends on - if I have understood everything correctly.

Reading your from jsonapi.org

This section describes the structure of a JSON API document, which is identified by the media type application/vnd.api+json. JSON API documents are defined in JavaScript Object Notation (JSON) [RFC7159].

2. When you say that JSON API is a superset of JSON, then you mean [ disclaimer : not a native English speaker ] that you fulfill the RFC7159 and have one or more extention ?
   I see your statement

Unless otherwise noted, objects defined by this specification MUST NOT contain any additional members. Client and server implementations MUST ignore members not recognized by this specification.
so I guess there are no additional members/elements ?

3. is there some kind of relationship between the sites json.org and jsonapi.org ?
   Is the purpose of jsonapi.org to help us understand RFC7159

I hope my questions are not to basic, the answers will help me argue for JSON-standard at my workplace.

regards, i

[steveklabnik]

@ingo

2. When you say that JSON API is a superset of JSON, then you mean [ disclaimer : not a native English speaker ] that you fulfill the RFC7159 and have one or more extention

Yes! All valid JSON API documents are also valid JSON documents.

@ingo

3. is there some kind of relationship between the sites json.org and jsonapi.org ?

The relationship is that this spec builds on top of that one, but there’s no further relationship.

[ingo]

Thank you Steve!

Reading through , http://jsonapi.org/about/ , I see that it says ‘This specification reached a stable version 1.0 on May 29, 2015.’ and that you are coming from the EmberJS side.
And by saying ‘this specification’ , could I say that the RFC7159 != jsonapi ?
So, my first attempt should be to align my API with RFC7159 to come up to a JSON-standard.
Then if I have clients, such as the Emberjs , then my step should be to comply with the jsonapi.org ?

regards, Ingo

[steveklabnik]

@ingo

And by saying ‘this specification’ , could I say that the RFC7159 != jsonapi ?

Yes. “This specification” is JSON API, not RFC 7159.

@ingo

So, my first attempt should be to align my API with RFC7159 to come up to a JSON-standard.

Absolutely, every JSON tool uses it to parse, stuff won’t work without it.

@ingo

Then if I have clients, such as the Emberjs , then my step should be to comply with the jsonapi.org ?

While JSON API came from Ember, it’s not limited to it. JSON:API — Implementations has libraries for all kinds of languages.

[ingo]

Thanks Steve!

Getting a bit wiser now.

regards, ingo

[beauby]

@steveklabnik

That is, JSON API is a superset of JSON.

Nitpicking: JSON API is actually a subset of JSON

[steveklabnik]

… yes. thanks

[Xavier]

JSON API is actually a subset of JSON.
javascript obfuscator https://javascript-obfuscator.org/