Application utilisée dans le cadre du cours de LOG210 et développée avec Node, Express et TypeScript.
Ce système doit être utilisé pour obtenir l'information de base pour la réalisation de votre laboratoire en LOG210. Il possède les qualités suivantes:
npm install
npm start
npm run test
npm run watch
npm run test -- -g "nom ou partie du nom d'un test"
Voir https://medium.com/@RupaniChirag/writing-unit-tests-in-typescript-d4719b8a0a40
La documentation de l'API a été générée avec apidoc.
Pour générer et consulter la documentation localement (par exemple, dans un clone), exécuter npm run all_docs
, puis npm start
. Ouvrir l'URL affichée dans la console.
Pour interagir avec l'API du SGB dans votre application, installer la bibliothèque suivante dans votre projet - npm install node-fetch
Puis, importer la bibliothèque dans le fichier .ts
concerné :
import fetch from 'node-fetch';
Exemple avec une requête GET
:
fetch("http://localhost:3200/api/v3/student/all")
.then(async response =>
{
var data = await response.json();
console.log(data);
})
.catch(error => console.error("Error: ", error));
Exemple avec une requête POST
:
var params = {
student_id: "first_name.last_name%2B1%40gmail.com",
group_id: "S20213-LOG210-01",
type: "Devoir1",
type_id: 2,
grade: 75.1
};
fetch("http://localhost:3200/api/v3/grade/insert",
{
method: "post",
body: JSON.stringify(params),
headers: {"Content-Type": "application/json"}
}).then(async response =>
{
var data = await response.json();
console.log(data);
});