TP04 : Deliver your API implementation

In this assignment, you will deliver the second part of results of the Node.js and OpenAPI codelab.

You must deliver the code of your Express Node.js application on git. The application must follow the Route-Controller architecture as documented in the Node.js and OpenAPI codelab.

When loading the Node.js application into WebStorm, one must be capable of successfully testing the application locally, without any other step than performing npm install.

Goals

After accomplishing this assignement, students will have implemented their own RESTful API defined with an OpenAPI specification document.

At the end of this assignment, students:

• will understand the important concepts behind any Express Node.js application, such as routing and middleware;
• will understand the Route-Controller architecture for implementing Express Node.js applications;
• will know how to use git for delivering the expected content.

The deliverables of the assignement are:

• a git repository named “tp04” in your group on “gitlab.forge.hefr.ch” with the Express Node.js application that implements your own API defined in a OpenAPI specification document. Note that the Node.js modules required for the application must NOT be pushed to the repository, but must rather be added to the project/application dependencies;
• the modified OpenAPI specification document for your API that contains the correct definitions for errors, pushed to the same git repository.
• a report in pdf format delivered using the related Teams assignment.
• a fix for all issues that have been reported for “tp03”. Issues will be reported at latest 4 days before the deadline for delivering “tp04”. The issues must be reported as closed on git.

Deadline

The deadline for delivering this assignment is given in the semester planning and in the corresponding assignment on Teams.

Testing

Add a section in your report that document how your application was tested. Automated tests will be introduced in a following codelab and assignement. At this stage, you must demonstrate how your application was tested without automated tests.

Report

The report must follow the following guidelines:

• It must be written in French or English.
• One title page with at least:
  • the school name and logo (official logo)
  • the course name : Module Application des données : Développement back-end
  • the title of the document : “Travail Pratique 4 : Réalisation de l’API”
  • your group number
  • the authors’ name
  • the report delivery date
• One short introduction for describing the context and goals
• A summary of the concepts that are important and that you should retain/fully understand, by commenting whether
  • the concept is not well understood (non acquis);
  • the concept is essentially understood, but some points remain to be exercised; (acquis, à exercer);
  • the concept is fully undertood (acquis).
• The answers to questions (if any).
• The parts of the code/source/specification that should be highlighted and that require specific attention.
• Some conclusions like what you have liked or not, remarks on how the codelab or assignement can be improved, and the number of hours that you have spent for each student of the group (outside hours in the classroom).

Important

Deliver your report based on instructions received during the lesson and according to the schedule. Your document must be named “report04.pdf”.