Milestone 2 Begüm Yivli Individual Report
- #132: Described the functionalities I'm going to implement, their views, endpoints, model and steps to my overall task.
- #150: Issue for writing this wiki page.
I utilized the Dictionary API. The API offers a straightforward RESTful interface, allowing users to make HTTP requests and receive JSON responses containing various word-related details like word definitions, synonyms and pronunciations.
To make the API call, I used the following URL: https://api.dictionaryapi.dev/api/v2/entries/en/hello
If you would like to learn more about the API, you can visit this link.
I have created 2 functions, including one GET request and one POST request. These functions are as follows:
-
addFavouriteWord- POST: This endpoint allows users to add a word to their favorites list by sending a request containing the necessary information. Upon successful addition, the endpoint responds with the ID of the newly added word, indicating that it has been successfully bookmarked.
-
getAllFavouriteWords- GET: This endpoint retrieves a list of favorite words associated with a specific user ID or all users if the ID is not provided. It returns a response containing the list of favorite words if the retrieval is successful, while a bad request response with an error message is returned if there is an issue in retrieving the favorite words.
ADD FAVOURITE:
EXAMPLE RESPONSE:16
GET ALL FAVOURITES:
EXAMPLE RESPONSE: [{"word":"hello","meaning":""},{"word":"saw","meaning":""},{"word":"saw","meaning":""},{"word":"hello","meaning":""},{"word":"hello","meaning":""},{"word":"hello","meaning":""},{"word":"hello","meaning":""},{"word":"love","meaning":""},{"word":"hello","meaning":""},{"word":"hello","meaning":""},{"word":"hello","meaning":""},{"word":"girl","meaning":""},{"word":"hello","meaning":""},{"word":"you","meaning":""},{"word":"dog","meaning":""},{"word":"cat","meaning":""}]
It was very difficult for me to do this project in a short time because I did not know backend and frontend. I probably couldn't have done it without the help of my teammates. I felt pretty inadequate. Even though I learned something, I wish there was more support in the course.