I’m building a quiz. A user can pick a subject and answer 5 questions. After each question they view the answer. I’m trying to stick to a strict RESTful representation of this workflow but cant really settle on a url scheme. For example:
User Joe picks the subject sport and is ready to see the first question. The url is
user/joe/subject/sport/question/1
When he submits his answer ‘B’ ( its a multiple choice quiz) , Joe is creating a new answer, we POST to
user/joe/subject/sport/question/1/answer/B
before viewing the correct answer at
user/joe/subject/sport/answer/1
we then view the next question at
user/joe/subject/sport/question/2
This is all obviously too complicated. How would you approach this problem in a RESTful manner?
Start with this presentation. It’s is a great resource for RESTful API design. With that in mind, here are some starting suggestions:
RESTful URLs have an implicit hierarchy. Take the user information out of the URL. It belongs in the HTTP headers.
I don’t see any useful information added by the
subjectpart. Thesubjectis identified by (in your example)sport.Categories should be plural.
When you POST to answer a question, you’re not POSTing to add a new answer resource (that is, defining a new possible answer). Aren’t you are POSTing to an existing resource?
You haven’t mentioned anything about HATEOAS. If you’re really going to implement REST, you should be doing things like providing “next” links in the hypermedia.