JSON Design & Query with Jersey

Question

I am trying to design a JSON object that would work with Jersey and Jackson.

Am fairly new to JSON / Restful programming, so I am wondering if the following is viable.

{
"name": "myservice",

"orders": [
    {
        "name": "iphone",
        "description": "iPhone 5",
        "providers": [
            {
                "name": "a",
                "description": "AT&T",
                "pricing": ["$40", "$70", "$120"]
            },
            {
                "name": "b",
                "description": "Verizon",
                "pricing": ["$45", "$60", "$85"]
            }
        ]
    },
    {
        "name": "galaxy3",
        "description": "Samsung Galaxy 3",
        "providers": [
            {
                "name": "a",
                "description": "AT&T",
                 "pricing": ["$45", "$60", "$85"]

            }
        ]
    }
]
}

Get all information regarding iPhone's Verizon provider:

 curl GET -H'Content-Type: application/json' https://mydomain/myservice/iphone/b

would return:

{
   "name": "b",
   "description": "Verizon",
   "pricing": ["$45", "$60", "$85"]
}

Get list of pricing for iPhone's AT&T provider:

curl GET -H'Content-Type: application/json' https://mydomain/myservice/iphone/a?pricing

Would return:

{

   ["$40", "$70", "$120"]

}

Any examples or feedback will be greatly appreciated!

What is your problem? What doesn't work? – Nov 08 '12 at 21:32 — , Nov 08 '12 at 21:32

score 0 · Answer 1 · edited May 23 '17 at 11:48

Here is a good discussion about defining a REST API: REST Complex/Composite/Nested Resources

Here is what I would change in your json: 1. orders -> order, because resources are declared as singular nouns 2. providers -> provider, because of the same

This is how I would call from a client if I know what I need to get (using composite resources):

https://<mydomain>/myservice/order/iphone/provider/b
https://<mydomain>/myservice/order/iphone/provider/a/pricing

In case you need to search for an order, you can define the request like:

https://<mydomain>/myservice/order?name=iphone -> it would return the 1st element in the "order" list

The assumption is that "name" is a key for the respective resouces (order and provider)

JSON Design & Query with Jersey

1 Answers1