web services - REST JSON specification -


i'm newbie both in soap , rest programming.

  • in soap structure , fields of entities being exchanged , unambiguously documented in wsdl.

  • i think same not happen in rest.

how developer of rest api supposed document structure , fields of json objects, representing entities being exchanged?

rest , soap can't compared directly, different things. can implement rest on soap if want, not opposite. recommend reading this answer.

in restful apis supposed document media-types , let interaction driven underlying protocol, don't in of http apis call rest. using term buzzword , opposite of that, documenting protocol instead of media-types.

for instance, if have user resource, supposed have proper media-type in format json or xml looks application/vnd.mycompany.user.v1+json, , documentation should describe json document looks client knows expect. doesn't have strict wsdl. in fact, can human readable documentation documenting class api or that.

the client can media-types prepared accept accept header. instance, if client wants v1 representation in json, can use like:

get /users/xyz accept: application/vnd.mycompany.user.v1+json

if wants v2 representation in xml, can use like:

get /users/xyz accept: application/vnd.mycompany.user.v2+xml

and if wants json , let server decide do, can use generic media-type , figure out server threw @ him checking content-type response header.

get /users/xyz accept: application/json

however, keep in mind of called rest apis you'll find don't use custom media-types this. instead, use same generic media-types application/json , application/xml everywhere. means clients have identify resources through uri semantics , relations, , that's not rest @ all. i'm not saying it's wrong, it's simple , works many problems, it's not rest , doesn't solve same kind of problems rest intends solve.


-

Popular posts from this blog

debugging - Reference - What does this error mean in PHP? -

what this? this number of answers warnings, errors , notices might encounter while programming php , have no clue how fix. community wiki, invited participate in adding , maintaining list. why this? questions "headers sent" or "calling member of non-object" pop on stack overflow. root cause of questions same. answers questions typically repeat them , show op line change in his/her particular case. these answers not add value site because apply op's particular code. other users having same error can not read solution out of because localized. sad, because once understood root cause, fixing error trivial. hence, list tries explain solution in general way apply. what should here? if question has been marked duplicate of this, please find error message below , apply fix code. answers contain further links investigate in case shouldn't clear general answer alone. if want contribute, please add "favorite" error message, warning or notic...
Read more

c++ - Why doesn't unordered_set provide an array access operator -

i'm curious why stl container unordered_set , has constant time complexity random access on average, not provide method accessing elements distance first element in container. example: t& unordered_set::operator[](size_t index) { return *(begin() + index); } accessing element "by distance" implies there meaningful way measure distance. trouble std::unordered_set is is, well, unordered . hence, there no meaningful way of explaining "some distance beginning" in non-arbitrary way. if want access distance, copy data vector: std::vector tmp(unordered.begin(), unordered.end());
Read more