Post parameter in path or in body

Question

I am creating Rest API but I am confused in URL structure. I have to send just one parameter to server in my Post request. should I send it through path variable or in request body? what are the best practices?

Example Current URL:

api/v1/users/{id}/name/{name}

name is the variable I want to send to server for to change state

Thanks

A POST implies the existence of a body. If you only want to update the name then send a PATCH to `api/v1/users/{id}`. — a better oliver, Feb 22 '17 at 12:44
Just another method. Like POST, but used to update only parts of a resource. Like in your case. — a better oliver, Feb 22 '17 at 13:05
ok got it, so in other words if I want to use POST then i should send state changing parameters through body. right? — muneebShabbir, Feb 22 '17 at 13:16
Does this answer your question? [REST API Best practices: Where to put parameters?](https://stackoverflow.com/questions/4024271/rest-api-best-practices-where-to-put-parameters) — Steve Chambers, Nov 27 '19 at 08:56

score 10 · Accepted Answer · answered Feb 22 '17 at 12:51

10

URL usually identifies resource you want to update.

So the data should go inside in request body

To update user name you may send this to server:

POST api/v1/users/{id} HTTP/1.1
Content-Type: application/x-www-form-urlencoded

name=string

answered Feb 22 '17 at 12:51

Andrii Muzalevskyi

2,997
13
18

Is there any supporting reference for do and don't for state changing variable? – muneebShabbir Feb 22 '17 at 13:02
1

Not sure if i understand your question in correct way. You may read about how REST approach could be implemented for example here http://jsonapi.org/format/ or here http://www.odata.org/getting-started/understand-odata-in-6-steps/ – Andrii Muzalevskyi Feb 22 '17 at 13:08
Thanks, I really appreciate that – muneebShabbir Feb 22 '17 at 13:23

Post parameter in path or in body

1 Answers1

Linked

Related