diff --git a/DOC.md b/DOC.md deleted file mode 100644 index 38f97be6c2a3d26074b4cd0c3127564b63da444f..0000000000000000000000000000000000000000 --- a/DOC.md +++ /dev/null @@ -1,386 +0,0 @@ - ---- - -# Documentation API : Créer un Quiz - -## Endpoint - -**POST** `/quiz/create` - -## Description - -Cet endpoint permet de créer un nouveau quiz et retourne ses détails, y compris les questions, les réponses et les métadonnées associées. - ---- - -### Corps de la requête - -| Champ | Type | Requis | Description | -|------------------|--------|---------|----------------------------------------------| -| `amount` | number | Oui | Nombre de questions dans le quiz. | -| `category` | number | Oui | ID de la catégorie des questions. | -| `difficulty` | string | Oui | Niveau de difficulté (`easy`, `medium`, `hard`). | - ---- - -### Exemple de requête - -```json -{ - "amount": 5, - "category": 22, - "difficulty": "easy" -} -``` - ---- - -### Corps de la réponse - -| Champ | Type | Description | -|--------------------|-----------------|----------------------------------------------| -| `id` | number | Identifiant unique du quiz. | -| `codeQuiz` | string | Code unique identifiant le quiz. | -| `score` | number | Score actuel du quiz. | -| `questionIndex` | number | Index de la question actuelle (commence à 1). | -| `questionCount` | number | Nombre total de questions dans le quiz. | -| `theme` | objet | Thème associé au quiz. | -| - `id` | number | Identifiant unique du thème. | -| - `name` | string | Nom du thème. | -| `difficulty` | objet | Niveau de difficulté du quiz. | -| - `id` | number | Identifiant unique du niveau de difficulté. | -| - `name` | string | Nom du niveau de difficulté. | -| `questions` | tableau d'objets| Liste des questions du quiz. | -| - `id` | number | Identifiant unique de la question. | -| - `text` | string | Texte de la question. | -| - `type` | string | Type de la question (`multiple`, `boolean`). | -| - `order` | number | Ordre de la question dans le quiz. | -| - `theme` | objet | Thème de la question. | -| --- `id` | number | Identifiant unique du thème. | -| --- `name` | string | Nom du thème. | -| - `answers` | tableau d'objets| Liste des réponses possibles pour la question. | -| --- `id` | number | Identifiant unique de la réponse. | -| --- `text` | string | Texte de la réponse. | - ---- - -### Exemple de réponse - -```json -{ - "id": 1, - "codeQuiz": "1IRCXV", - "score": 0, - "questionIndex": 1, - "questionCount": 5, - "theme": { - "id": 1, - "name": "Geography" - }, - "difficulty": { - "id": 1, - "name": "easy" - }, - "questions": [ - { - "id": 5, - "text": "Quelle est la langue officielle du Costa Rica ?", - "type": "multiple", - "order": 1, - "theme": { - "id": 1, - "name": "Geography" - }, - "answers": [ - { - "id": 13, - "text": "Espagnol" - }, - { - "id": 14, - "text": "Anglais" - }, - { - "id": 15, - "text": "Portugais" - }, - { - "id": 16, - "text": "Créole" - } - ] - }, - { - "id": 4, - "text": "Toronto est la capitale du Canada.", - "type": "boolean", - "order": 2, - "theme": { - "id": 1, - "name": "Geography" - }, - "answers": [ - { - "id": 11, - "text": "Faux" - }, - { - "id": 12, - "text": "Vrai" - } - ] - } - ] -} -``` - ---- - -### Notes - -- Assurez-vous que les valeurs de `category` et `difficulty` correspondent aux valeurs valides fournies par l'API. Les entrées invalides renverront une erreur. -- Le champ `order` dans le tableau `questions` indique l'ordre des questions dans le quiz. - ---- - -Voici la documentation pour la route **POST /quiz/answer** : - ---- - -# Documentation API : Répondre à une Question - -## Endpoint - -**POST** `/quiz/answer` - -## Description - -Cet endpoint permet de vérifier si une réponse donnée est correcte, de mettre à jour le score du quiz, d'incrémenter l'index de la question actuelle, et de retourner les réponses à la question ainsi que le score actuel. - ---- - -### Corps de la requête - -| Champ | Type | Requis | Description | -|--------------|--------|---------|----------------------------------------------| -| `codeQuiz` | string | Oui | Code unique identifiant le quiz. | -| `questionID` | number | Oui | Identifiant unique de la question. | -| `answerID` | number | Oui | Identifiant unique de la réponse. | - ---- - -### Exemple de requête - -```json -{ - "codeQuiz": "1IRCXV", - "questionID": 4, - "answerID": 12 -} -``` - ---- - -### Corps de la réponse - -| Champ | Type | Description | -|-----------|-----------------|-----------------------------------------------| -| `score` | number | Score actuel du quiz après mise à jour. | -| `answers` | tableau d'objets| Liste des réponses associées à la question. | -| - `id` | number | Identifiant unique de la réponse. | -| - `text` | string | Texte de la réponse. | -| - `isCorrect` | boolean | Indique si la réponse est correcte ou non. | -| - `questionId` | number | Identifiant de la question associée. | - ---- - -### Exemple de réponse - -```json -{ - "score": 3, - "answers": [ - { - "id": 11, - "text": "False", - "isCorrect": false, - "questionId": 4 - }, - { - "id": 12, - "text": "True", - "isCorrect": true, - "questionId": 4 - } - ] -} -``` - ---- - -### Fonctionnement - -1. Vérifie si la réponse donnée (via `answerID`) est correcte en se basant sur la question (`questionID`) et le quiz (`codeQuiz`). -2. Si la réponse est correcte, incrémente le score du quiz. -3. Incrémente l'index de la question actuelle dans le quiz. -4. Récupère les réponses à la question spécifiée. -5. Retourne un objet contenant le score actuel et les réponses à la question. - ---- - -### Notes - -- Le champ `isCorrect` dans les réponses permet d’identifier quelle réponse est correcte. -- Si la réponse donnée est incorrecte, seul l'index de la question est incrémenté, le score reste inchangé. -- Le code unique `codeQuiz` doit correspondre à un quiz existant. - ---- - -Voici la documentation pour la route **POST /quiz/remaining** : - ---- - -# Documentation API : Questions restantes pour un quiz - -## Endpoint - -**POST** `/quiz/remaining` - -## Description - -Cet endpoint renvoie les questions restantes d’un quiz en fonction de l’index actuel de la question (`questionIndex`). Les questions précédentes ne sont pas incluses, et les réponses ne contiennent pas le champ `isCorrect`. - ---- - -### Corps de la requête - -| Champ | Type | Requis | Description | -|------------|--------|---------|----------------------------------------------| -| `codeQuiz` | string | Oui | Code unique identifiant le quiz. | - ---- - -### Exemple de requête - -```json -{ - "codeQuiz": "1IRCXV" -} -``` - ---- - -### Corps de la réponse - -| Champ | Type | Description | -|-------------------|-----------------|-----------------------------------------------| -| `id` | number | Identifiant unique du quiz. | -| `codeQuiz` | string | Code unique du quiz. | -| `score` | number | Score actuel du quiz. | -| `questionIndex` | number | Index actuel de la question dans le quiz. | -| `questionCount` | number | Nombre total de questions dans le quiz. | -| `theme` | objet | Thème du quiz. | -| - `id` | number | Identifiant du thème. | -| - `name` | string | Nom du thème. | -| `difficulty` | objet | Niveau de difficulté du quiz. | -| - `id` | number | Identifiant du niveau de difficulté. | -| - `name` | string | Nom du niveau de difficulté. | -| `questions` | tableau d'objets| Liste des questions restantes dans le quiz. | -| - `id` | number | Identifiant unique de la question. | -| - `text` | string | Texte de la question. | -| - `type` | string | Type de la question (`multiple` ou `boolean`).| -| - `order` | number | Ordre de la question dans le quiz. | -| - `theme` | objet | Thème associé à la question. | -| -- `id` | number | Identifiant du thème. | -| -- `name` | string | Nom du thème. | -| - `answers` | tableau d'objets| Liste des réponses disponibles. | -| -- `id` | number | Identifiant unique de la réponse. | -| -- `text` | string | Texte de la réponse. | - ---- - -### Exemple de réponse - -```json -{ - "id": 1, - "codeQuiz": "1IRCXV", - "score": 2, - "questionIndex": 2, - "questionCount": 5, - "theme": { - "id": 1, - "name": "Geography" - }, - "difficulty": { - "id": 1, - "name": "easy" - }, - "questions": [ - { - "id": 4, - "text": "Toronto is the capital city of the North American country of Canada.", - "type": "boolean", - "order": 2, - "theme": { - "id": 1, - "name": "Geography" - }, - "answers": [ - { - "id": 11, - "text": "False" - }, - { - "id": 12, - "text": "True" - } - ] - }, - { - "id": 3, - "text": "Which of the following languages does NOT use the Latin alphabet?", - "type": "multiple", - "order": 3, - "theme": { - "id": 1, - "name": "Geography" - }, - "answers": [ - { - "id": 7, - "text": "Georgian" - }, - { - "id": 8, - "text": "Turkish" - }, - { - "id": 9, - "text": "Swahili" - }, - { - "id": 10, - "text": "Vietnamese" - } - ] - } - ] -} -``` - ---- - -### Fonctionnement - -1. **Vérification du quiz :** Récupère le quiz correspondant au `codeQuiz`. -2. **Filtrage des questions :** Sélectionne les questions restantes en fonction de `questionIndex`. -3. **Exclusion de la propriété `isCorrect` :** Toutes les réponses associées à une question sont renvoyées sans le champ `isCorrect`. -4. **Retourne le quiz modifié :** Inclut les questions restantes avec leurs réponses simplifiées. - ---- - -### Notes - -- La route est conçue pour s'assurer que seules les questions restantes à jouer sont retournées, évitant de révéler des informations inutiles ou les questions déjà jouées. -- Utile pour reprendre un quiz à un état sauvegardé. diff --git a/README.md b/README.md index c17103c312893b8adf93855534dccb81c042bf42..98e3c0610ebad4cd8c39edc66df98978524e76d9 100644 --- a/README.md +++ b/README.md @@ -1,99 +1,494 @@ -<p align="center"> - <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a> -</p> - -[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 -[circleci-url]: https://circleci.com/gh/nestjs/nest - - <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> - <p align="center"> -<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> -<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> -<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> -<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> -<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> -<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> -<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> -<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> - <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a> - <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> - <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a> -</p> - <!--[](https://opencollective.com/nest#backer) - [](https://opencollective.com/nest#sponsor)--> + +--- + +# Documentation API : Créer un Quiz + +## Endpoint + +**POST** `/quiz/create` + +## Description + +Cet endpoint permet de créer un nouveau quiz et retourne ses détails, y compris les questions, les réponses et les métadonnées associées. + +--- + +### Corps de la requête + +| Champ | Type | Requis | Description | +|------------------|--------|---------|----------------------------------------------| +| `amount` | number | Oui | Nombre de questions dans le quiz. | +| `category` | number | Oui | ID de la catégorie des questions. | +| `difficulty` | string | Oui | Niveau de difficulté (`easy`, `medium`, `hard`). | + +--- + +### Exemple de requête + +```json +{ + "amount": 5, + "category": 22, + "difficulty": "easy" +} +``` + +--- + +### Corps de la réponse + +| Champ | Type | Description | +|--------------------|-----------------|----------------------------------------------| +| `id` | number | Identifiant unique du quiz. | +| `codeQuiz` | string | Code unique identifiant le quiz. | +| `score` | number | Score actuel du quiz. | +| `questionIndex` | number | Index de la question actuelle (commence à 1). | +| `questionCount` | number | Nombre total de questions dans le quiz. | +| `theme` | objet | Thème associé au quiz. | +| - `id` | number | Identifiant unique du thème. | +| - `name` | string | Nom du thème. | +| `difficulty` | objet | Niveau de difficulté du quiz. | +| - `id` | number | Identifiant unique du niveau de difficulté. | +| - `name` | string | Nom du niveau de difficulté. | +| `questions` | tableau d'objets| Liste des questions du quiz. | +| - `id` | number | Identifiant unique de la question. | +| - `text` | string | Texte de la question. | +| - `type` | string | Type de la question (`multiple`, `boolean`). | +| - `order` | number | Ordre de la question dans le quiz. | +| - `theme` | objet | Thème de la question. | +| --- `id` | number | Identifiant unique du thème. | +| --- `name` | string | Nom du thème. | +| - `answers` | tableau d'objets| Liste des réponses possibles pour la question. | +| --- `id` | number | Identifiant unique de la réponse. | +| --- `text` | string | Texte de la réponse. | + +--- + +### Exemple de réponse + +```json +{ + "id": 1, + "codeQuiz": "1IRCXV", + "score": 0, + "questionIndex": 1, + "questionCount": 5, + "theme": { + "id": 1, + "name": "Geography" + }, + "difficulty": { + "id": 1, + "name": "easy" + }, + "questions": [ + { + "id": 5, + "text": "Quelle est la langue officielle du Costa Rica ?", + "type": "multiple", + "order": 1, + "theme": { + "id": 1, + "name": "Geography" + }, + "answers": [ + { + "id": 13, + "text": "Espagnol" + }, + { + "id": 14, + "text": "Anglais" + }, + { + "id": 15, + "text": "Portugais" + }, + { + "id": 16, + "text": "Créole" + } + ] + }, + { + "id": 4, + "text": "Toronto est la capitale du Canada.", + "type": "boolean", + "order": 2, + "theme": { + "id": 1, + "name": "Geography" + }, + "answers": [ + { + "id": 11, + "text": "Faux" + }, + { + "id": 12, + "text": "Vrai" + } + ] + } + ] +} +``` + +--- + +### Notes + +- Assurez-vous que les valeurs de `category` et `difficulty` correspondent aux valeurs valides fournies par l'API. Les entrées invalides renverront une erreur. +- Le champ `order` dans le tableau `questions` indique l'ordre des questions dans le quiz. + +--- + +Voici la documentation pour la route **POST /quiz/answer** : + +--- + +# Documentation API : Répondre à une Question + +## Endpoint + +**POST** `/quiz/answer` + +## Description + +Cet endpoint permet de vérifier si une réponse donnée est correcte, de mettre à jour le score du quiz, d'incrémenter l'index de la question actuelle, et de retourner les réponses à la question ainsi que le score actuel. + +--- + +### Corps de la requête + +| Champ | Type | Requis | Description | +|--------------|--------|---------|----------------------------------------------| +| `codeQuiz` | string | Oui | Code unique identifiant le quiz. | +| `questionID` | number | Oui | Identifiant unique de la question. | +| `answerID` | number | Oui | Identifiant unique de la réponse. | + +--- + +### Exemple de requête + +```json +{ + "codeQuiz": "1IRCXV", + "questionID": 4, + "answerID": 12 +} +``` + +--- + +### Corps de la réponse + +| Champ | Type | Description | +|-----------|-----------------|-----------------------------------------------| +| `score` | number | Score actuel du quiz après mise à jour. | +| `answers` | tableau d'objets| Liste des réponses associées à la question. | +| - `id` | number | Identifiant unique de la réponse. | +| - `text` | string | Texte de la réponse. | +| - `isCorrect` | boolean | Indique si la réponse est correcte ou non. | +| - `questionId` | number | Identifiant de la question associée. | + +--- + +### Exemple de réponse + +```json +{ + "score": 3, + "answers": [ + { + "id": 11, + "text": "False", + "isCorrect": false, + "questionId": 4 + }, + { + "id": 12, + "text": "True", + "isCorrect": true, + "questionId": 4 + } + ] +} +``` + +--- + +### Fonctionnement + +1. Vérifie si la réponse donnée (via `answerID`) est correcte en se basant sur la question (`questionID`) et le quiz (`codeQuiz`). +2. Si la réponse est correcte, incrémente le score du quiz. +3. Incrémente l'index de la question actuelle dans le quiz. +4. Récupère les réponses à la question spécifiée. +5. Retourne un objet contenant le score actuel et les réponses à la question. + +--- + +### Notes + +- Le champ `isCorrect` dans les réponses permet d’identifier quelle réponse est correcte. +- Si la réponse donnée est incorrecte, seul l'index de la question est incrémenté, le score reste inchangé. +- Le code unique `codeQuiz` doit correspondre à un quiz existant. + +--- + +Voici la documentation pour la route **POST /quiz/remaining** : + +--- + +# Documentation API : Questions restantes pour un quiz + +## Endpoint + +**POST** `/quiz/remaining` ## Description -[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. +Cet endpoint renvoie les questions restantes d’un quiz en fonction de l’index actuel de la question (`questionIndex`). Les questions précédentes ne sont pas incluses, et les réponses ne contiennent pas le champ `isCorrect`. + +--- -## Project setup +### Corps de la requête -```bash -$ npm install +| Champ | Type | Requis | Description | +|------------|--------|---------|----------------------------------------------| +| `codeQuiz` | string | Oui | Code unique identifiant le quiz. | + +--- + +### Exemple de requête + +```json +{ + "codeQuiz": "1IRCXV" +} ``` -## Compile and run the project +--- -```bash -# development -$ npm run start +### Corps de la réponse -# watch mode -$ npm run start:dev +| Champ | Type | Description | +|-------------------|-----------------|-----------------------------------------------| +| `id` | number | Identifiant unique du quiz. | +| `codeQuiz` | string | Code unique du quiz. | +| `score` | number | Score actuel du quiz. | +| `questionIndex` | number | Index actuel de la question dans le quiz. | +| `questionCount` | number | Nombre total de questions dans le quiz. | +| `theme` | objet | Thème du quiz. | +| - `id` | number | Identifiant du thème. | +| - `name` | string | Nom du thème. | +| `difficulty` | objet | Niveau de difficulté du quiz. | +| - `id` | number | Identifiant du niveau de difficulté. | +| - `name` | string | Nom du niveau de difficulté. | +| `questions` | tableau d'objets| Liste des questions restantes dans le quiz. | +| - `id` | number | Identifiant unique de la question. | +| - `text` | string | Texte de la question. | +| - `type` | string | Type de la question (`multiple` ou `boolean`).| +| - `order` | number | Ordre de la question dans le quiz. | +| - `theme` | objet | Thème associé à la question. | +| -- `id` | number | Identifiant du thème. | +| -- `name` | string | Nom du thème. | +| - `answers` | tableau d'objets| Liste des réponses disponibles. | +| -- `id` | number | Identifiant unique de la réponse. | +| -- `text` | string | Texte de la réponse. | -# production mode -$ npm run start:prod +--- + +### Exemple de réponse + +```json +{ + "id": 1, + "codeQuiz": "1IRCXV", + "score": 2, + "questionIndex": 2, + "questionCount": 5, + "theme": { + "id": 1, + "name": "Geography" + }, + "difficulty": { + "id": 1, + "name": "easy" + }, + "questions": [ + { + "id": 4, + "text": "Toronto is the capital city of the North American country of Canada.", + "type": "boolean", + "order": 2, + "theme": { + "id": 1, + "name": "Geography" + }, + "answers": [ + { + "id": 11, + "text": "False" + }, + { + "id": 12, + "text": "True" + } + ] + }, + { + "id": 3, + "text": "Which of the following languages does NOT use the Latin alphabet?", + "type": "multiple", + "order": 3, + "theme": { + "id": 1, + "name": "Geography" + }, + "answers": [ + { + "id": 7, + "text": "Georgian" + }, + { + "id": 8, + "text": "Turkish" + }, + { + "id": 9, + "text": "Swahili" + }, + { + "id": 10, + "text": "Vietnamese" + } + ] + } + ] +} ``` -## Run tests +--- + +### Fonctionnement + +1. **Vérification du quiz :** Récupère le quiz correspondant au `codeQuiz`. +2. **Filtrage des questions :** Sélectionne les questions restantes en fonction de `questionIndex`. +3. **Exclusion de la propriété `isCorrect` :** Toutes les réponses associées à une question sont renvoyées sans le champ `isCorrect`. +4. **Retourne le quiz modifié :** Inclut les questions restantes avec leurs réponses simplifiées. + +--- + + +### Notes + +- La route est conçue pour s'assurer que seules les questions restantes à jouer sont retournées, évitant de révéler des informations inutiles ou les questions déjà jouées. +- Utile pour reprendre un quiz à un état sauvegardé. + -```bash -# unit tests -$ npm run test +# Documentation API : Création Utilisateur -# e2e tests -$ npm run test:e2e +## Endpoint +**POST** `/user` -# test coverage -$ npm run test:cov +## Description + +Cet endpoint permet de créer un nouvel utilisateur, avec des identifiants uniques. + +### Corps de la requête + +| Champ | Type | Requis | Description | +|-------|------|--------|-------------| +| `username` | string | Oui | Unique | +| `email` | string | Oui | Unique | +| `password` | string | Oui | | + +### Exemple de requête + +```json +{ + "email":"arbre@gmail.com", + "login":"yggdrasil", + "password":"AAAHONMEMANGE" +} ``` -## Deployment +### Exemple de réponse + +```json +{ + "id": 1, + "username": "yggdrasil", + "email": "arbre@gmail.com", +} +``` + +# Documentation API : Connexion Utilisateur + +## Endpoint + +**POST** `/auth/login` + +## Description + +Cet endpoint renvoie un cookie `access_token` permettant d'identifier l'utilisateur s'il renseigne ses identfifiants. + +--- -When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information. +### Corps de la requête -If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps: +| Champ | Type | Requis | Description | +|-------|------|--------|-------------| +| `login`| string | Oui | Nom d'utilisateur ou adresse e-mail | +|`password`|string| Oui | Mot de passe| -```bash -$ npm install -g mau -$ mau deploy +### Exemple de requête + +```json +{ + "login":"yggdrasil", + "password":"AAAHONMEMANGE" +} ``` -With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure. +# Documentation API : Infos Utilisateur + +## Endpoint + +**GET** `/user/:id` -## Resources +## Description + +Cet endpoint permet de récupérer les informations d'un utilisateur + +### Exemple de réponse -Check out a few resources that may come in handy when working with NestJS: +```json +{ + "id": 1, + "username": "yggdrasil", + "email": "arbre@gmail.com", +} +``` + +# Documentation API : Infos de l'utilisateur connecté -- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework. -- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy). -- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/). -- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks. -- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com). -- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com). -- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs). -- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com). +## Endpoint -## Support +**GET** `/user/me` -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). +## Description -## Stay in touch +Cet endpoint renvoie les informations de l'utilisateur connecté, ou renvoie une erreur sinon. -- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) -## License +### Exemple de réponse -Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE). +```json +{ + "id": 1, + "username": "yggdrasil", + "email": "arbre@gmail.com", +} +``` \ No newline at end of file