The @Body annotation defines a single request body. interface Foo { @POST(“/jayson”) FooResponse postJson(@Body FooRequest body); } Since Retrofit uses Gson by default, the FooRequest instances will be serialized as JSON as the sole body of the request. public class FooRequest { final String foo; final String bar; FooRequest(String foo, String bar) { this.foo = … Read more
I agree with Fionn, but I’ll go one step further and say that to me the Page is not a resource, it’s a property of the request. That makes me chose option 1 query string only. It just feels right. I really like how the Twitter API is structured restfully. Not too simple, not too … Read more
If there are documented best practices, I have not found them yet. However, here are a few guidelines I use when determining where to put parameters in an url: Optional parameters tend to be easier to put in the query string. If you want to return a 404 error when the parameter value does not … Read more
I’m not familiar with napping, but using Golang’s net/http package works fine (playground): func main() { url := “http://restapi3.apiary.io/notes” fmt.Println(“URL:>”, url) var jsonStr = []byte(`{“title”:”Buy cheese and bread for breakfast.”}`) req, err := http.NewRequest(“POST”, url, bytes.NewBuffer(jsonStr)) req.Header.Set(“X-Custom-Header”, “myvalue”) req.Header.Set(“Content-Type”, “application/json”) client := &http.Client{} resp, err := client.Do(req) if err != nil { panic(err) } defer … Read more
To easily manipulate URLs / path / params / etc., you can use Spring’s UriComponentsBuilder class to create a URL template with placehoders for the parameters, then provide the value for those parameters in the RestOperations.exchange(…) call. It’s cleaner than manually concatenating strings and it takes care of the URL encoding for you: HttpHeaders headers … Read more
A 400 means that the request was malformed. In other words, the data stream sent by the client to the server didn’t follow the rules. In the case of a REST API with a JSON payload, 400’s are typically, and correctly I would say, used to indicate that the JSON is invalid in some way … Read more
To access the entity body of a POST or PUT request (or any other HTTP method): $entityBody = file_get_contents(‘php://input’); Also, the STDIN constant is an already-open stream to php://input, so you can alternatively do: $entityBody = stream_get_contents(STDIN); From the PHP manual entry on I/O streamsdocs: php://input is a read-only stream that allows you to read … Read more
Best practice for RESTful API design is that path params are used to identify a specific resource or resources, while query parameters are used to sort/filter those resources. Here’s an example. Suppose you are implementing RESTful API endpoints for an entity called Car. You would structure your endpoints like this: GET /cars GET /cars/:id POST … Read more
At Boundless, we’ve gone deep with option #2 and rolled it out to thousands of students. Our server is a JSON REST API (Scala + MongoDB), and all of our client code is served straight out of CloudFront (ie: www.boundless.com is just an alias for CloudFront). Pros: Cutting-edge/exciting A lot of bang for your buck: … Read more
Since you’re using requests, you should use the response’s json method. import requests response = requests.get(…) data = response.json() It autodetects which decoder to use.