-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation2.txt
More file actions
26 lines (20 loc) · 2.48 KB
/
Copy pathdocumentation2.txt
File metadata and controls
26 lines (20 loc) · 2.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
What dataset are you using?
I am using the books.json data set
What went right in the development of this project?
The UI development of the project and the client side aspect of API calls went correctly as they were similar to other API projects and assignments I've done in the past.
What went wrong in the development of this project?
I did have to review some of the different API server concepts, such as HEAD/POST and the correct error codes. I also had to refresh my memory on how to work with JSON files and format it within HTML files. I had a lot of trouble getting started and hitting the first milestone, very little if any of my api backend was working. The project also took me a lot longer than I initially thought it would, leading to some very stressful last minute scrambles only to miss the initial deadlines. For future projects I definitely need to dedicate some more time to starting sooner.
What did you learn while developing this project?
I learned the structure of an API and I becsame much more familiar with the different kinds of requests and their functions/uses.
If you went above and beyond, how did you do so?
I went above and beyond with the UI. I structured my own UI using Bulma and fontawesome (linked below). I created "blocks" for each kind of request, added icons to suggest their uses, labelled buttons to distinguish between GET/HEAD/POST request, and prompts in the textboxes to make it clearer for users their options.
If you used any borrowed code or code fragments, where did you get them from? What do the code fragments do? Where are they in your code?
For server.js I referenced the code from an office hours conversation I had with Professor Willoughby and the file from http api assignment 2 of the same name. This just gave me a starting point for how to redirect requests for methods and paths.
For bookResponses.js to get started with I referenced responses.js from http api assignment 2, again this gave me a model/template for different GET/HEAD/POST methods and how to organize them within my code.
For the documentation html page I referenced the film api example given in the assignment.
Other Sources/Documentation:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
https://stackoverflow.com/questions/4810841/pretty-print-json-using-javascript
https://www.w3schools.com/tags/tag_pre.asp#:~:text=Example,Try%20it%20Yourself%20%C2%BB
https://fontawesome.com/search?q=book&ip=classic&ic=free-collection
https://bulma.io/documentation/