api - PUT or POST when making idempotnet request for specific use-case -


i'm designing rest api web application.

my principles while designing api are:

  • use client use cases perspective rather data model perspective. motivation: abstract db schema.
  • each slash represent new use case/action.

lets in application have users, products, locations, product-news. use case user follows product-news location. if location empty user follows news product each location.
list of products , locations known.

what right method adding user follower of specific product-location combination?

i end following url:

/product/follow?product=<product_name>[&location=<location name>]

the product , location names in query part because more flexible extend in future.

  • the argument put: of course request idempotent - sending multiple times doesn't make other change sending once.
  • the argument post: don't specify url, under resource set.

personally i'm closer put because use-case principle api (which consider right one) impotency rule seams corresponding one.

first identify resources. i'd that

/products/<product_name>/followers

is list of users following product_name. can filter using query parameters:

/products/<product_name>/followers?location=<location_name>

is list of users following product_name location_name.

a get request against such resource returns representation (json, xml, ...) of list of users.

post or put

a post request against such resource adds new user. request body of such post request contains details.

post /products/<product_name>/followers content-type: application/json  {   "user": "some user",   "location: "some location" }

the server respond:

201 created location: /products/<product_name>/followers/some%20user

if client knows uri, can use put:

put /products/<product_name>/followers/some%20user content-type: application/json  {   "location: "some location" }

the server again respond:

201 created location: /products/<product_name>/followers/some%20user

summary

if client able know uri, can use put. the url can known server, use post.


Comments

Post a Comment

Popular posts from this blog

How to remove text and logo OR add Overflow on Android ActionBar using AppCompat on API 8? -

have researched death , cannot find answer. i have actionbar using appcompat. supporting api v7 (api v8 do). actionbar works api v11. api < v11 has problem of removing icon (and feature) actionbar without supplying overflow. big picture have app logo, app title, , 3 icons squidging same actionbar on low end phone. trying make room! i happy 1 of 2 solutions. either: a method of getting overflow functionality can retrieved pull down. (preferred) method of removing icon , text actionbar below current xml api 11+: <resources> <!-- base application theme api 11+. theme replaces appbasetheme res/values/styles.xml on api 11+ devices. --> <style name="appbasetheme" parent="theme.appcompat.light.darkactionbar"> <item name="android:actionbarstyle">@style/liteactionbarstyle</item> <item name="actionbarstyle">@style/liteactionbarstyle</item> </st...
Read more

html - How to style widget with post count different than without post count -

i have border below li elements in wordpress widget types appropriate. element inside set block gives them nice easy click full width. the problem, when choose option "show post count" when adding widget such categories or archives displays post count plain text after tag , because tag block pushes post number text line below. whether choose show post count or not show post count still gives exact same element identifyer example "widget_categories". how style post count not on next line still keep links non post count list items full width? here's example on sidebar www.bbmthemes.com/themes/modular/blog-standard/ in order solve problem need remove display:block; for ul.widgets ul a , add in it's place line-height: 33px; what going achieve have same visual effect. what going lose doing links going work on text , not on "box". the other way out of find post count coming , make changes this. example change text count i...
Read more

url rewriting - How to redirect a http POST with urlrewritefilter -

i have question urlrewritefilter , until not find in net. i want redirect http post in tomcat7. here example... the call http post ulr http://localhost:8080/oldapplication/example?a=123&b=2 this call contains content either xml or json. filter configured works , urlrewrite.xml contains: <?xml version="1.0" encoding="utf-8"?> <!doctype urlrewrite public "-//tuckey.org//dtd urlrewrite 4.0//en" "http://www.tuckey.org/res/dtds/urlrewrite4.0.dtd"> <urlrewrite use-query-string="true"> <rule> <condition type="method">post</condition> <from>^(.*)$</from> <to type="redirect">/newapplication$1</to> </rule> </urlrewrite> in access log can see call http://localhost:8080/oldapplication/example?a=123&b=2 gets redirected http://localhost:8080/newapplication/example?a=123&b=2 fine until now. pr...
Read more