Skip to content
#

json-api

json logo

JSON (JavaScript Object Notation) is a standard file format that uses text to communicate data objects to array data types. This notation makes it easy for applications to parse and generate files. JSON grew out of the need to have a real-time server-to-web browser communication.

Here are 1,652 public repositories matching this topic...

coronavirus-tracker-api
Akuukis
Akuukis commented Mar 27, 2020

Great stuff! I'm planning to use API for my dashboard Pandemic Estimator but I wish your API had a better documentation on methodology. I'm using JHU directly and I know what chaos it is, the most blatant example being that they provide "cumulative data" that's not cumulative quite often in practice. And the whole change of file formats, etc.

Can you please de

aklish
aklish commented Dec 5, 2019

Expected Behavior

Swagger (JSON-API) allows attributes and relationships to have user defined descriptions added to the documentation through the ApiModelProperty annotation.

GraphQL should support a similar mechanism.

Current Behavior

The description for attributes is left blank.

Possible Solution

Create a new Elide annotation that adds descriptions (and other attributes in A

allthesignals
allthesignals commented Mar 29, 2020

The serialization docs say the following:

ref: If present, it's considered as a relationships.
id: Configurable identifier field for the resource. Default: id.

I don't understand what one is doing over the other? What if I specify a ref but no id, and there is no id field?

Happy to contribute to clarify docs once I understand the difference.

Thanks.

shadowhand
shadowhand commented Jun 17, 2017

Unless the pagination links are removed from the URI passed to Document::addPaginationLinks() the output will be duplicated:

	"links": {
		"first": "https:\/\/api.acme.net\/users?page%5Blimit%5D=5?page%5Blimit%5D=5",
		"next": "https:\/\/api.acme.net/users?page%5Blimit%5D=5?page%5Blimit%5D=5&page%5Boffset%5D=5"
	}

It should be clearly documented that the passed URI must be

odalysadam
odalysadam commented Jan 20, 2020

So just a friendly hint and maybe I'm not having the brightest day, but without much prior knowledge to the topic of json:apis I found your documention rather hard.
You get very much into the Initializer and the advanced features, but skip the basic parts like the Model defining process and how the attributes get mapped. (Having a "post" as a type here is just a tad misleading btw.)
If you cou

vanitom
vanitom commented Jul 31, 2016

Hello,

I discovered Laravel and Lumen. I want to create a clean API. I would like to implement JSON API. I tested your library.
I discovered some errors in the documentation.

For the controller, it would indicate the need to put the controller in the directory "app/Http/Controllers/Api".
Since the namespace of the controller is not correct. There must be "App/Http/Controllers/Api".

In the r

garytaylor
garytaylor commented Nov 17, 2015

Whilst the relationships work find and are well documented for reading - I am finding that I really do not know what I am doing when trying to use them during creation / updating of a resource. I was expecting this to work :-

forum = Forum.find(1).first
forum.posts << Post.find(5)
forum.save

This is assuming that a forum has many posts

Please can you add some examples to the readme to

Created by Douglas Crockford

Released 2005

Website
www.json.org
Wikipedia
Wikipedia
You can’t perform that action at this time.