Skip to content

analysis and reflection

Jump to bottom
KhanSehrish edited this page Jun 2, 2022 · 8 revisions

Important information for final deadline

‼️  This chapter should be completed by final deadline (see course information at Lovelace)

📑  Chapter summary In this section we would like that you reflect about the work you have done during the course.

SECTION GOALS:

  • Reflect about own learning
  • Feedback on course instruction
In this section we are going to evaluate also the project management
✔️     Chapter evaluation (max 4.5 points) You can get a maximum of 4.5 points after completing the Analysis and Reflection section.

Analysis and reflection

Future Work

📑  Content that must be included in the section Explain how you would improve your RESTful API and your client application. Try to develop the ideas, and explain why each improvement is needed
✔️     Evaluation criteria(max 1.5 points)
  • Future work is provided and carefully thought out: 1.5

✏️ Following steps are suggested to improve the EatHelp API and the client application in future:

  • Adding Authentication: We could implement API keys to restrict access to certain resources by only allowing some of the resource methods. (E.g. not allowing a client to DELETE a resource unless they have administrative privileges)

  • **Thorough Unit Testing:**The API was mainly tested using different HTTP methods on Postman. We weren’t able to implement any other tests on the API due to a late start on the project.

  • Using custom URL converters: We could improve the readability of the resource URLs by allowing different parameters in the URL and converting those to the required format, or by utilizing other unique identifiers as the parameters.

  • Implementing Hypermedia

  • Adding CLI commands: CLI commands will help further to install and run the API with different configurations

  • extending more error handling: currently, we have added error handling, more error handling can be added by attaching internal codes and description regarding errors

  • releasing newer versions: Improved versions of the existing API can be released in future

  • improving documentation: For helping the clients with new features and improvements

  • Feedback from users: Taking useful feedback from users to try it once and using their feedback as an input for enhancing the implementation of the API.

Lessons learnt

📑  Content that must be included in the section Discuss in this section the things that you would have done differently if you started the project after this course ends.
✔️     Evaluation criteria(max 1.0 points)
  • A short reflective description of what was learned while working on the project 1.0

✏️ Write here your text

Comments about the project

The EatHelp API

📑  Content that must be included in the section Comment where you encountered the main difficulties while doing your project work. Discuss about the easiest/most difficult parts of the project. Provide convincing statements.
✔️     Evaluation criteria(max 1.0 points)
  • A short reflective description of the easiest/most difficults parts of the projects 1.0

✏️ Write here your text

Comments about the course

📑  Content that must be included in the section Make sincere comments about the course. How this course could be improved? What should be changed? What should not be changed?
✔️     Evaluation criteria(max 1.0 points)
  • Useful course feedback - what we should change, what we should keep: 1.0

✏️ Write here your text

Resources allocation

Task Student Estimated time

Report index

Clone this wiki locally