rest - Is it always relevant to target RESTful design for a public web service/API? -


no doubt restful buzz word , seems cleaver design pattern in many cases.

struggling apply own web apis (existing , upcoming) wonder if relevant (if forget fact in rfc's try respond ;)).

first of i'm dealing dynamic data determined @ least 3 parameters, possibly 10.

think instance web api performing sound effects , format conversion (equalize, echo, volume, speed, ...). need send credentials, undeterminated set of effect name , settings , sound equalize.

the url effectmaker/echo/10pct/equalizer/20khz/-10pct/output-rate/192kbps/

  • some parameters in http header (response format instance)

  • the sound in body.

so, functions defined http methods + url root , parameters in body, url tail , header. not seems convenient, neither me nor developers discovering api.

besides that, caching ability not make sens of users request unique.

so, i'm asking if i'm wrong thinking should try integrate makes sens in rest "philosophy" (stateless, discoverable, ...) use, drop part of pointless (cacheable) or makes api odd? instance should stick http verbs when push data in body , expect converted data in response?

to me seems restfull design makes sens when manage / consume online databases items accessible through quite simple path. when api creates/transforms data unique usage seems inconvenient. when have dozen of parameters accepting various values, seems painfull.

however, soap , xml-rpc standards quite ugly in opinion...

so bad make restlike or asrestasrelevant design associated json parameters/response when seems wiser?

any advice of standard follow in case?

cheers,

vincent

rest not philosophy. it's architectural style - way of designing systems meet goals. if goals aren't yours, rest bad idea. if are, rest idea. don't know goals are, have no idea if rest fit you.

this next bit doesn't have rest, it's more generic web api design,

don't use url contain processing instructions. say, that's totally unwieldy non-trivial systems. either support multipart requests contain processing instructions in 1 part , audio file in part, or treat file upload , processing instructions 2 separate requests. support both.

just spitballing, if trying design restish api, might start near

post /audio-files  request: content-type: audio/midi <audio file>  response: 201 created location: http://example.com/audio-files/12

-

post /audio-files  request: content-type: multipart/mixed; boundary="simple boundary" --simple boundary content-type: application/json; charset=us-ascii {    "echo": "true",    ... } --simple boundary content-type: audio/midi; charset=us-ascii <audio file> --simple boundary--  response: 200 ok link: <http://example.com/audio-files/12>; rel="audio-file" <altered-audio-file>

-

post /altered-audio-files  request: content-type: application/json; charset=us-ascii {     "audio-file": "http://example.com/audio-files/12"     "echo": "true",     ... }  response: 200 ok <altered-audio-file>

this treats audio file , altered audio files resources. allows save on wire time holding onto uploaded audio files when wants run 8 transformations on same file, , gives option hold onto altered audio files if later choose so. if want track requests, adding third endpoint, maybe /audio-requests.


Comments

Post a Comment

Popular posts from this blog

node.js - Node js - Trying to send POST request, but it is not loading javascript content -

i have been trying send post request website, , has not been loading full site. i guessing problem node js not loading javascript content, executing it. can see javascript in response, though never loads content javascript files producing in html. what mean is, doesn't execute javascript. how make node js code overcome this, , wait the full website load? have tried native code, , "request' module, both producing same errors. if helps, don't need native javascript. modules fine. some code have tried (request module): var options = { method: 'post', uri: 'https://url', formdata: { 'email': 'email', 'prize': '0', 'transactional': 'on' }, headers: { /* 'content-type': 'application/x-www-form-urlencoded' */ // set automatically } }; rp(options) .then(function (body) { console.log(body) }) .catch(function (err) { console.log(err) }); when fetch content...
Read more

javascript - Replicate keyboard event with html button -

i have tried few ways make happen. have javascript pinball game uses keyboard keys controls. converting application touch screen display. workaround, hoping overlay buttons when clicked simulate keyboard strokes. have done research , sounds should work. using jquery v3.2.1 here things have tried far... html element: <input type="button" class="coil"></input> $('.coil').trigger({type: 'keydown', which: 40, keycode: 40}); with this, not errors, nothing happens. var coilkey = $('body').keydown(function(e) { switch (e.keycode) { case 40: break;} }) $('.coil').click(coilkey); this 1 returns error in console... ((jquery.event.special[handleobj.origtype] || (intermediate value)).handle || handleobj.handler).apply not function below javascript game engine handles key listeners... addkeylistener: function (keyandlistener) { this.keylisteners.push(keyandlistener); }, // gi...
Read more

javascript - Web audio api 5.1 surround example not working in firefox -

i've been playing lott lately web audio api on both firefox , chrome. few days ago started experiment surround set. when trying surround audio in web audio api came notice example works fine in chrome v59 not in firefox v54. // create web audio api context var audioctx = new (window.audiocontext || window.webkitaudiocontext)(); audioctx.destination.channelinterpretation = 'discrete'; audioctx.destination.channelcountmode = 'explicit'; audioctx.destination.channelcount = 6; var oscillators = []; var merger = audioctx.createchannelmerger(6); console.log(audioctx.destination, merger); //merger.channelinterpretation = 'discrete'; //merger.channelcountmode = 'explicit'; //merger.channelcount = 6; var addoscilator = function(channel, frequency) { var oscillator = audioctx.createoscillator(); oscillator.frequency.value = frequency; // value in hertz oscillator.connect(merger,0,channel); oscillator.start(); oscillators.push(o...
Read more