Aller au contenu

TP01 : Deliver the Results of the OpenAPI codelab

In this assignment, you will deliver the results of the Introduction to OpenAPI codelab.

You must deliver the complete set of documents for the OpenAPI specification of both the planets and your own API in JSON or YAML format including all endpoints.

The document must be delivered on git based on instructions received in the lesson and given below. When loading the document into WebStorm, one must be capable of fully understanding the RESTful API. For the Planets API, testing the RESTful API using the servers as specified in the codelab (without modifying the specification document) must also be possible.

Goals

This assignment should familiarize students with the RESTful API concept, the OpenAPI specification and tools. It is the basis for implementing your RESTful API at a later date.

At the end of this assignment, students:

  • have installed all required tools for starting writing OpenAPI specifications and developing the related RESTful API;
  • will know how to use those tools;
  • will know the most important rules for designing a RESTful API;
  • will know how to use git for delivering the expected content;
  • have written an assignment report delivered on Classe Développement Back-end 2024-2025, based on instructions received during the lesson.

The deliverables of the assignement are:

  • a git repository named “tp01” in your group on “gitlab.forge.hefr.ch” with the OpenAPI specification document;
  • a report in pdf format delivered on Teams.

Deadline

The deadline for delivering this assignment is given in the semester planning.

Analysis

Add a section in your report that describes how the RESTful rules described in the Introduction to OpenAPI codelab and in the lecture slides are respected by your API.

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 1 : Introduction à OpenAPI et ses outils”
    • 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 analysis as described here.
  • 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 “report01.pdf”.