doc

README.md

-# SAÉ_REST_API
+# SAÉ S4.A02. : Web Backend
 
+### Objectif:
 
+Savoir réaliser et mettre en place une architecture REST.
+Cette SAÉ ne met en oeuvre que les compétences REST.
 
-## Getting started
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## Base de données
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+La base de données est une base de données relationnelle. Elle est composée de 5 tables:
+- **`ingredients`** : contient tout les ingrédients qui commposent les pizzas (id, name, price)
+- **`pizzas`** : contient les pizzas (nom, pate, prixbase)
+- **`pizzas_ingredients`** : contient les ingrédients qui composent les pizzas (nom, id) nom est le nom de la pizza et id est l'id de l'ingrédient 
 
-## Add your files
+- **`commandes`** : contient les commandes (id, nom, date)
+- **`commande_detail`** : contient les pizzas commandées (id,  nom) id est l'id de la commande et nom est le nom de la pizza commandée 
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+## API Ingredients
 
+### GET /ingredients
+
+Renvoie la liste des ingrédients présents dans la base de données
+
+```json
+[
+    {
+        "id": 1,
+        "name": "pomme de terre",
+        "price": 1
+    },
+    {
+        "id": 2,
+        "name": "crème",
+        "price": 2
+    }
+]
+```
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+
+
+### GET /ingredients/{id}
+
+Renvoie l'ingrédient correspondant à l'id passé en paramètre
+
+```json
+{
+    "id": 1,
+    "name": "pomme de terre",
+    "price": 1
+}
+```
+
+Status | Description
+------------ | -------------
+302 FOUND | La requête s'est effectuée correctement
+404 NOT FOUND | L'ingrédient n'existe pas
+
+### GET /ingredients/{id}/name
+
+Renvoie le nom de l'ingrédient correspondant à l'id passé en paramètre
+
+```json
+{
+    "name": "pomme de terre"
+}
+```
+Status | Description
+------------ | -------------
+302 FOUND | La requête s'est effectuée correctement
+404 NOT FOUND | L'ingrédient n'existe pas
+
+### POST /ingredients
+
+Ajoute un ingrédient à la base de données avec les informations passées en paramètre au format JSON.
+
+Body:
+```json
+{   
+    "id": 1,
+    "name": "pomme de terre",
+    "price": 1
+}
 ```
-cd existing_repo
-git remote add origin https://gitlab.univ-lille.fr/antoine.gaienier.etu/sae_rest_api.git
-git branch -M main
-git push -uf origin main
+et renvoie l'ingrédient ajouté
+
+```json
+{   
+    "id": 1,
+    "name": "pomme de terre",
+    "price": 1
+}
 ```
+Status | Description
+------------ | -------------
+201 CREATED | La requête s'est effectuée correctement
+409 CONFLICT | L'ingrédient existe déjà
 
-## Integrate with your tools
+### DELETE /ingredients/{id}
 
-- [ ] [Set up project integrations](https://gitlab.univ-lille.fr/antoine.gaienier.etu/sae_rest_api/-/settings/integrations)
+Supprime l'ingrédient correspondant à l'id passé en paramètre et ne renvoie rien
 
-## Collaborate with your team
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND| L'ingrédient n'existe pas
 
-## Test and Deploy
+### PUT /ingredients
 
-Use the built-in continuous integration in GitLab.
+Modifie l'ingrédient avec les informations passées en paramètre au format JSON.
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+Body:
+```json
+{   
+    "id": 1,
+    "name": "truffe",
+    "price": 10
+}
+```
+et renvoie l'ingrédient modifié
+
+```json
+{   
+    "id": 1,
+    "name": "truffe",
+    "price": 10
+}
+```
+Status | Description
+------------ | -------------
+ 200 OK | La requête s'est effectuée correctement
+ 404 NOT FOUND |L'ingrédient n'existe pas
 
-***
+### PATCH /ingredients/{id}
 
-# Editing this README
+Modifie l'ingrédient correspondant à l'id passé en paramètre avec les informations passées en paramètre au format JSON.
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+Body:
+```json
+{   
+    "price": 5.5
+}
+```
+et renvoie l'ingrédient modifié
+
+```json
+{   
+    "id": 1,
+    "name": "pomme de terre",
+    "price": 5.5
+}
+```
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404  NOT FOUND |L'ingrédient n'existe pas
+
+## API Pizzas
+
+### GET /pizzas
+
+Renvoie la liste des pizzas présentes dans la base de données
+
+```json
+[
+    {
+        "nom": "4 fromages",
+        "pate": "fine",
+        "prixbase": 10
+    },
+    {
+        "nom": "reine",
+        "pate": "fine",
+        "prixbase": 12
+    }
+]
+```
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+
+### GET /pizzas/{nom}
+
+Renvoie la pizza correspondant au nom passé en paramètre et les ingrédients qui la composent
+
+```json
+{
+    "nom": "4 fromages",
+    "pate": "fine",
+    "prixbase": 10,
+    "ingredients": [
+        {
+            "id": 1,
+            "name": "pomme de terre",
+            "price": 1
+        },
+        {
+            "id": 2,
+            "name": "crème",
+            "price": 2
+        }
+    ]
+}
+```
+Status | Description
+------------ | -------------
+302 FOUND | La requête s'est effectuée correctement
+404 NOT FOUND | La pizza n'existe pas
 
-## Suggestions for a good README
+### GET /pizzas/{nom}/prixfinal
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+Renvoie le prix final de la pizza correspondant au nom passé en paramètre
 
-## Name
-Choose a self-explaining name for your project.
+```json
+{
+    13
+}
+```
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+Status | Description
+------------ | -------------
+302 FOUND | La requête s'est effectuée correctement
+404 NOT FOUND | La pizza n'existe pas
+
+### POST /pizzas
+
+Ajoute une pizza à la base de données avec les informations passées en paramètre au format JSON
+
+Body:
+```json
+{   
+    "nom": "4 fromages",
+    "pate": "fine",
+    "prixbase": 10
+    "ingredients": [
+        {
+            "id": 1,
+        },
+        {
+            "id": 2,
+            "name": "crème",
+        }
+    ]
+}
+```
+
+et renvoie la pizza ajoutée
+
+```json
+{   
+    "nom": "4 fromages",
+    "pate": "fine",
+    "prixbase": 10
+    "ingredients": [
+        {
+            "id": 1,
+            "name": "pomme de terre",
+            "price": 1
+        },
+        {
+            "id": 2,
+            "name": "crème",
+            "price": 2
+        }
+    ]
+}
+```
+Status | Description
+------------ | -------------
+201 CREATED | La requête s'est effectuée correctement
+409 CONFLICT | La pizza existe déjà
+
+### DELETE /pizzas/{nom}
+
+Supprime la pizza correspondant au nom passé en paramètre et ne renvoie rien
+
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La pizza n'existe pas
+
+### DELETE /pizzas/{nom}/{id}
+
+Supprime la relation entre la pizza correspondant au nom passé en paramètre et l'ingrédient correspondant à l'id passé en paramètre et ne renvoie rien
+
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La pizza ou l'ingrédient n'existe pas
+
+### PUT /pizzas/{nom}
+
+Modifie la pizza correspondant au nom passé en paramètre avec les informations passées en paramètre au format JSON
+
+Body:
+```json
+{   
+    "nom": "hawaienne",
+    "pate": "fine",
+    "prixbase": 10
+    "ingredients": [
+        {
+            "id": 1,
+        },
+        {
+            "id": 10,
+            "name": "ananas",
+        },
+        {
+            "id": 5,
+            "name":" sauce tomate"
+        }
+    ]
+}
+```
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La pizza n'existe pas
+
+### PATCH /pizzas/{nom}
+
+Modifie la pizza correspondant au nom passé en paramètre avec les informations passées en paramètre au format JSON. 
+
+Body:
+```json
+{   
+    "prixbase": 15
+}
+
+qui modifie le prix de la pizza correspondant au nom passé en paramètre et renvoie la pizza modifiée  et renvoie la pizza modifiée
+
+```json
+{   
+    "nom": "4 fromages",
+    "pate": "fine",
+    "prixbase": 15
+    "ingredients": [
+        {
+            "id": 1,
+            "name": "pomme de terre",
+            "price": 1
+        },
+        {
+            "id": 2,
+            "name": "crème",
+            "price": 2
+        }
+    ]
+}
+```
+ou 
+
+Body:
+
+```json
+{   
+    "ingredients": [
+        {
+            "id": 1,
+        },
+        {
+            "id": 10,
+
+        }
+    ]
+}
+```
+qui modifie les ingrédients de la pizza correspondant au nom passé en paramètre et renvoie la pizza modifiée
+
+```json
+{   
+    "nom": "4 fromages",
+    "pate": "fine",
+    "prixbase": 10
+    "ingredients": [
+        {
+            "id": 1,
+            "name": "pomme de terre",
+            "price": 1
+        },
+        {
+            "id": 10,
+            "name": "ananas",
+            "price": 3
+        }
+    ]
+}
+```
+
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La pizza n'existe pas
+
+## API Commandes
+
+### GET /commandes
+
+Renvoie la liste des commandes présentes dans la base de données
+
+```json
+[
+    {
+        "id": 1,
+        "nom": "commande1",
+        "date": "2021-03-01"
+    },
+    {
+        "id": 2,
+        "nom": "commande2",
+        "date": "2021-03-02"
+    }
+]
+```
+
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+
+### GET /commandes/{id}
+
+Renvoie la commande correspondant à l'id passé en paramètre et les pizzas commandées
+
+```json
+{
+    "id": 1,
+    "nom": "commande1",
+    "date": "2024-03-01",
+    "pizzas": [
+        {
+            "nom": "4 fromages",
+            "pate": "fine",
+            "prixbase": 10
+            "ingredients": [
+                {
+                    "id": 1,
+                    "name": "pomme de terre",
+                    "price": 1
+                },
+                {
+                    "id": 2,
+                    "name": "crème",
+                    "price": 2
+                }
+            ]
+        },
+        {
+            "nom": "reine",
+            "pate": "fine",
+            "prixbase": 12
+            "ingredients": [
+                {
+                    "id": 1,
+                    "name": "pomme de terre",
+                    "price": 1
+                },
+                {
+                    "id": 2,
+                    "name": "crème",
+                    "price": 2
+                }
+            ]
+        }
+    ]
+}
+```
+
+Status | Description
+------------ | -------------
+302 FOUND | La requête s'est effectuée correctement
+404 NOT FOUND | La commande n'existe pas
+
+### GET /commandes/{id}/prixfinal
+
+Renvoie le prix final de la commande correspondant à l'id passé en paramètre
+
+```json
+{
+    25
+}
+``` 
+
+Status | Description
+------------ | -------------
+302 FOUND | La requête s'est effectuée correctement
+404 NOT FOUND | La commande n'existe pas
+
+### POST /commandes
+
+Ajoute une commande à la base de données avec les informations passées en paramètre au format JSON
+
+Body:
+```json
+{   
+    "id": 1,
+    "nom": "commande1",
+    "date": "2024-03-01",
+    "pizzas": [
+        {
+            "nom": "4 fromages",
+        },
+        {
+            "nom": "reine",
+        }
+    ]
+}
+```
+
+et renvoie la commande ajoutée
+
+```json
+{   
+    "id": 1,
+    "nom": "commande1",
+    "date": "2024-03-01",
+    "pizzas": [
+        {
+            "nom": "4 fromages",
+            "pate": "fine",
+            "prixbase": 10
+            "ingredients": [
+                {
+                    "id": 1,
+                    "name": "pomme de terre",
+                    "price": 1
+                },
+                {
+                    "id": 2,
+                    "name": "crème",
+                    "price": 2
+                }
+            ]
+        },
+        {
+            "nom": "reine",
+            "pate": "fine",
+            "prixbase": 12
+            "ingredients": [
+                {
+                    "id": 1,
+                    "name": "pomme de terre",
+                    "price": 1
+                },
+                {
+                    "id": 2,
+                    "name": "crème",
+                    "price": 2
+                }
+            ]
+        }
+    ]
+}
+```
+
+Status | Description
+------------ | -------------
+201 CREATED | La requête s'est effectuée correctement
+409 CONFLICT | La commande existe déjà
+
+### DELETE /commandes/{id}
+
+Supprime la commande correspondant à l'id passé en paramètre et ne renvoie rien
+
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La commande n'existe pas
+
+### DELETE /commandes/{id}/{nom}
+
+Supprime la relation entre la commande correspondant à l'id passé en paramètre et la pizza correspondant au nom passé en paramètre et ne renvoie rien
+
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La commande ou la pizza n'existe pas
+
+### PUT /commandes/{id}
+
+Modifie la commande correspondant à l'id passé en paramètre avec les informations passées en paramètre au format JSON
+
+Body:
+```json
+{   
+    "id": 1,
+    "nom": "commande1",
+    "date": "2024-03-01",
+    "pizzas": [
+        {
+            "nom": "4 fromages",
+        },
+        {
+            "nom": "reine",
+        }
+    ]
+}
+```
+et renvoie la commande modifiée
+
+```json
+{   
+    "id": 1,
+    "nom": "commande1",
+    "date": "2024-03-01",
+    "pizzas": [
+        {
+            "nom": "4 fromages",
+            "pate": "fine",
+            "prixbase": 10
+            "ingredients": [
+                {
+                    "id": 1,
+                    "name": "pomme de terre",
+                    "price": 1
+                },
+                {
+                    "id": 2,
+                    "name": "crème",
+                    "price": 2
+                }
+            ]
+        },
+        {
+            "nom": "reine",
+            "pate": "fine",
+            "prixbase": 12
+            "ingredients": [
+                {
+                    "id": 1,
+                    "name": "pomme de terre",
+                    "price": 1
+                },
+                {
+                    "id": 2,
+                    "name": "crème",
+                    "price": 2
+                }
+            ]
+        }
+    ]
+}
+```
+
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La commande n'existe pas
+
+### PATCH /commandes/{id}
+
+Modifie la commande correspondant à l'id passé en paramètre avec les informations passées en paramètre au format JSON
+
+Body:
+```json
+{   
+    "date": "2024-03-02"
+    "pizzas": [
+        {
+            "nom": "4 fromages",
+        }
+    ]
+}
+```
+
+et renvoie la commande modifiée
+
+```json
+{   
+    "id": 1,
+    "nom": "commande1",
+    "date": "2024-03-02",
+    "pizzas": [
+        {
+            "nom": "4 fromages",
+            "pate": "fine",
+            "prixbase": 10
+            "ingredients": [
+                {
+                    "id": 1,
+                    "name": "pomme de terre",
+                    "price": 1
+                },
+                {
+                    "id": 2,
+                    "name": "crème",
+                    "price": 2
+                }
+            ]
+        }
+    ]
+}
+```
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+Status | Description
+------------ | -------------
+200 OK | La requête s'est effectuée correctement
+404 NOT FOUND | La commande n'existe pas
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+## Restrictions d'accès
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+La partie restriction d'accès n'est pas implémentée par manque de temps.
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## Bruno
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+Bruno est organisé de façon à pouvoir lancer le runnner de l'application sans avoir d'erreur.
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+- Ingredients
+- ingredientsFail
+- Pizzas
+- PizzasFail
+- Commandes
+- CommandesFail
 
-## License
-For open source projects, say how it is licensed.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

WEB-INF/bruno/pizzeria/1_Ingredient/Ingredient Delete.bru → WEB-INF/bruno/pizzeria/1_Ingredients/Ingredient Delete.bru

@@ -10,6 +10,4 @@ delete {
   auth: none
 }
 
-docs {
-  Avant de faire ce DELETE vou de vais faire la requête "IngrediantPost"
-}
+