covcom / 205CDE

Developing the Modern Web
6 stars 24 forks source link

RESTful API issues & about the worksheet completion time estimation #21

Open JoseUusitalo opened 8 years ago

JoseUusitalo commented 8 years ago

Typo:

Finally we have DELETE method which is used to remove resources and collections. By choosing POST at the left hand side and giving URL and the issue, we will have

The instructions for setting up your own REST API using the given index.php file need clarification. I was unable to get it working by doing everything according to the instructions. (Or that's what I though I was doing.) With a little help from my teacher we were able to figure it out.

I though that I was supposed to create a new folder called staffapi and create folders called "person" and "persons" inside that. The worksheet should explain that the staffapi, person & persons parts of the example URL are not supposed to be actual folders but are just keywords in the URI. I'm not sure we were even explained the difference between the two. It is well within the realm of reason to think that whoever made the worksheet simply made a typo writing "URL" considering the number of grammatical mistakes in the previous worksheets.

Next, we define two resources: 1. persons, a collection of persons 2. person, a single person

What does "defining resources" even mean in this context? I though this meant I had to create folders.

Even though the instructions say you should create a new Codio project for this exercise I figured it would just create more trouble for the teachers so I just used the single project like we were instructed to by the teachers. I think it should be clarified that you need to create the .htaccess at the root of the Apache server (the folder that opens when you open the box URL) because that is not necessarily the root of the project folder if you have modified the Apache server configuration.

This lab takes approximately 2 hours.

I spent almost an hour trying to do the "check your understanding" bit by using the https://cityofhelsinki-erja.firebaseio.com/ API and eventually came to the conclusion that it is just broken because I was unable to anything except get JSON files out using the URLs in the images. Using the actual City of Helsinki issue API I was able to sort through the data using various parameters with Postman.

I took me a bit over two hours do the first "Test your understanding" task. I spent over an hour struggling with getting the example REST API working on my server and I still haven't even started on the final task.

Although this particular worksheet is an extreme example this is still a common theme in worksheets where there is an estimate of how long it should take to complete the tasks. It usually takes me around twice as long to finish them and from what I gather I have finished all or most of the worksheets faster than anyone else in my class. Even at my pace I have constantly been 1-3 worksheets behind the teaching.

vesavvo commented 8 years ago

Thanks for comments. Resources clarified. Explained the non-match between the folders and URI parts. Put more emphasis for creating a new project.Explained the reason to this. Changed time estimation from "approximately" to "at least". Observations on time requirements taken seriously for future development.