REST API design for utility calculations -


i'm trying design api balances restful recommended practices overall usability , 1 thing i'm struggling design of utility methods calculating things.

specifically, homebrewing there many things brewer wants calculate during process: color, bitterness, abv, etc. guess it's simple enough have /calculators endpoint resulting get returning available calculators:

  • /calculators/1
  • /calculators/2

though in case it's more user-friendly return:

  • /calculators/abv
  • /calculators/ibu

what should get on calculator resource like? should values make calculation url params (/calculators/abv?og=1.050&fg=1.021)? what's appropriate response/response code when necessary params aren't provided or invalid combination of params provided? there more sensible design other resource per calculation type specify above?

there few response codes use, 400 general 'client error', 1 of those. can include body explain wrong.

the way have formed request seems reasonable enough me, it's hard it's bit of contrived example.

for simple calculations, format might work ok. more complex calculations, might want consider having single argument encodes entire calculation, think 6 * 9 ^ 10 / 6.


Comments

Post a Comment

Popular posts from this blog

javascript - RequestAnimationFrame not working when exiting fullscreen switching space on Safari -

request animation frame stops working when exiting fullscreen clicking on original space's safari window. fine if fullscreen mode canceled escape key or calling cancelfullscreen(). steps reproduce: open https://dl.dropboxusercontent.com/u/769042/prezi/safari-fullscreen.html click "draw raf", kittie appears click "fullscreen", go fullscreen click "draw raf", kittie appears go space original safari was, showing "click exit fullscreen mode", click anywhere, out fullscreen click "draw raf", nothing happens what handling click calling: window.requestanimationframe(draw); which draws on canvas context: function draw() { ctx.drawimage(img, math.random()*500|0, math.random()*400|0, 100, 100); } i checked .hidden , .visibilitystate, updated correctly. tested on osx 10.9.3, safari 7.0.4 (9537.76.4). has workaround/solution other switching old settimeout? this sounds webkit bug 88940 : using reque
Read more

Python ctypes access violation with const pointer arguments -

i have api i'm trying wrap in python (2.7.6 on win7) code using ctypes. here's api: client_dllfunc bool clientapi search_exporttoclipcopy(clienthsearch handle, int channel, lpctstr filename, const time_t& from, const time_t& to, const bool* cameras, int length, bool usepassword, lpctstr password, bool includetextin = false, bool excludeplayer = false); the issue i'm having cameras argument; , i've had issue other const pointer arguments well. here's how i'm wrapping api: def search_exporttoclipcopy(self, hsearch, csearch, filename, tfrom, tto, cameras, length, usepassword, password, includetextin=true, excludeplayer=false): exporttoclipcopy = self.sdkdll.search_exporttoclipcopy exporttoclipcopy.argtypes = [c_int, c_int, c_wchar_p, c_long, c_long, pointer(c_bool), c_int, c_bool, c_wchar_p, c_bool, c_bool] exporttoclipcopy.restype = c_bool exporttoclipcopy(hsearch, csearch, filename, tfrom, tto, cameras, length, usepassword, pass
Read more