{"id":18301259,"url":"https://github.com/leosery/api_nosql--js","last_synced_at":"2026-05-08T14:13:59.770Z","repository":{"id":169533479,"uuid":"632480390","full_name":"LeoSery/API_NoSQL--JS","owner":"LeoSery","description":"This project is an API made in JS and mongoDB for my undergraduate year 3 (2022/2023) for a course project. ","archived":false,"fork":false,"pushed_at":"2023-04-25T19:02:37.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-26T09:05:23.970Z","etag":null,"topics":["api","api-rest","database","js","mongodb","nosql","web"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LeoSery.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-25T13:48:44.000Z","updated_at":"2023-05-25T20:23:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"56d5b02a-770d-4894-bda5-21248ce33e68","html_url":"https://github.com/LeoSery/API_NoSQL--JS","commit_stats":null,"previous_names":["leosery/api_nosql--js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LeoSery/API_NoSQL--JS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeoSery%2FAPI_NoSQL--JS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeoSery%2FAPI_NoSQL--JS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeoSery%2FAPI_NoSQL--JS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeoSery%2FAPI_NoSQL--JS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LeoSery","download_url":"https://codeload.github.com/LeoSery/API_NoSQL--JS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LeoSery%2FAPI_NoSQL--JS/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273996696,"owners_count":25204472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-rest","database","js","mongodb","nosql","web"],"created_at":"2024-11-05T15:14:57.559Z","updated_at":"2026-05-08T14:13:54.745Z","avatar_url":"https://github.com/LeoSery.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Projet Final NoSQL - Léo Séry B3GDPROG\n\nCe projet contient une **API** réaliser pour le projet Final du module **NoSQL**. Vous trouverez ci dessous tout ce dont vous avez besoin pour la faire fonctionner.\n\n## Contents :\n\n- **Introduction** au projet.\n- **Installer** l'API.\n- **Configurer** l'API.\n- **Tester** l'API.\n\n## Introduction au projet :\n\nCe projet contient un **API en JS**. Cette API livré avec un **modele de base de donnée** pouvant contenir des personnages. Un fichier **`ExampleOfDatabaseContent.json`** contient un objet JSON avec des personnage de l'Univers _Marvel_, vous pouvez les utilisez lors de **tests de l'API**.\n\nUn autre fichier nommé **`api.http`** peut vous aidez à réalisez les test de l'API, il contient toutes les requetes possible pour l'API.\n\nCette API dispo des fonctionalités de base pour faire un **CRUD**.\nVous pouvez **réaliser les actions suivantes** :\n\n- Ajouter un personnage\n- Ajouter plusieurs personnages en une requete\n- Récupérer tous les personnages de la BDD\n- Récupérer un personnage de la BDD via son ID\n- Update les informations d'un personnage via son ID\n- Supprimer un personnage via son ID\n- Supprimer tous les personnages de la BDD\n\nCette API comporte aussi 2 autres features afin de pouvoir trier et rechercher un personnages via une requete. Vous pouvez :\n\n- Recherche un personnage via :\n  - son Nom\n  - son Prénom\n  - son Alias\n- Trier les personnages dans l'ordre croissant et décroissant via les critères suivants :\n  - son Nom\n  - son Prénom\n  - son Alias\n\n## Installer l'API :\n\nvous trouvez l'API dans le dossier **`SÉRY_LÉO_API_NOSQL\\app`** de ce .zip. Vous pouvez aussi la télécharger sur [mon repo GitHub](https://github.com/LeoSery/API_NoSQL--JS).\n\nOu la clonner via les liens suivants :\n\n```\ngit@github.com:LeoSery/API_NoSQL--JS.git\n```\n\nou\n\n```\nhttps://github.com/LeoSery/API_NoSQL--JS.git\n```\n\n## Configurer l'API :\n\nUne fois l'API récupérer, vous aller pouvoir la **configurer avant de l'utiliser**. Dans un terminal i**nstaller les node_modules** via la commande : **`npm install`**.\n\nEnsuite **créer une base de donnée MongoDB** via **la ligne de commande** ou en utilisant l'application **`mongoDBCompass`**. Créer une connection vers cette base de donnée et **garder l'URL** et le **port d'accès** pour pouvoir les rentrer par la suite.\n\nDans le fichier **`.env`** du projet, dans le champ **`MONGO_URL`** renseigner **l'URL de votre base de donnée** suivit **du port** que vous avez enregistrer ci dessus et enfin le **nom de votre BDD**.\n\nComme ceci : **`MONGO_URL=mongodb://{YourDatabaseIP}:{YourDatabasePort}/{YourDatabaseName}`**\n\nToujours dans le fichier **`.env`**, dans le champ **`PORT`** renseigner le champs sur lequel l'API devra tourner.\n\n## Tester l'API :\n\nPour **tester l'API**, vous pouvez utiliser le fichier **`api.http`** qui contient toutes les requetes necessaires pour tester l'API si vous avez l'extension nommé **`REST Client`** [disponible sur le store](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) de Visual Studio Code.\n\nSinon vous pouvez **tester l'API manuellement** en suivant les indications ci dessous :\n\n**URL pour accéder a l'API** : `http://localhost:{YourDatabasePort}`.\n\n### Ajouter un personnage :\n\nType de requete : **POST**\nRoute : _`/characters`_\nContent :\n\n```\n{\n    \"id\": 1,\n    \"first_name\": \"NewCharacterFirstName\",\n    \"last_name\": \"NewCharacterLastName\",\n    \"alias\": \"NewCharacterAlias\",\n    \"height\": 100\n}\n```\n\n### Ajouter plusieurs personnages :\n\nType de requete : **POST**\nRoute : _`/characters`_\nContent :\n\n```\n[\n  {\n    \"id\": 1,\n    \"first_name\": \"NewCharacterFirstName\",\n    \"last_name\": \"NewCharacterLastName\",\n    \"alias\": \"NewCharacterAlias\",\n    \"height\": 100\n  },\n  {\n    \"id\": 2,\n    \"first_name\": \"NewCharacterFirstName\",\n    \"last_name\": \"NewCharacterLastName\",\n    \"alias\": \"NewCharacterAlias\",\n    \"height\": 100\n  }\n]\n```\n\n### Récupérer tous les personnages :\n\nType de requete : **GET**\nRoute : _`/characters`_\nContent : `None`\n\n### Récupérer un personnage via son ID :\n\nType de requete : **POST**\nRoute : _`/characters/{ID}`_\nContent : `None`\n\n### Mettre a jour un personnage via son ID :\n\nType de requete : **PUT**\nRoute : _`/characters/{ID}`_\n\n```\n{\n\"first_name\": \"NewFirstName\",\n\"last_name\": \"NewLastName\",\n\"alias\": \"NewAlias\",\n\"height\": 100\n}\n```\n\n### Supprimer un personnage via son ID :\n\nType de requete : **DELETE**\nRoute : _`/characters/{ID}`_\nContent : `None`\n\n### Supprimer tous les personnages :\n\nType de requete : **DELETE**\nRoute : _`/characters`_\nContent : `None`\n\n### Recherche un personnage via son Nom, Prénom ou Alias :\n\nType de requete : **GET**\nRoute : _`/characters/search/{SearchValue}`_\nContent : `None`\n\n### Trier les personnages suivant un critère et dans un ordre précis :\n\nType de requete : **GET**\nRoute : _`/characters/sort/{SortValue}/{SortOrder}`_\nContent : `None`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleosery%2Fapi_nosql--js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleosery%2Fapi_nosql--js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleosery%2Fapi_nosql--js/lists"}