|
|
[](https://codefirst.iut.uca.fr/victor_perez.ngounou/BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
|
|
|
|
|
|
# Bowling Score API
|
|
|
|
|
|
|
|
|
<img src="Documentation/doc_images/bowling-157933.png" height=40/>
|
|
|
|
|
|
## Description
|
|
|
|
|
|
Cette API fournit des services pour gérer les scores d'un jeu de bowling.
|
|
|
Elle permet de créer des joueurs, des parties et de gérer les scores de chaque joueur pour chaque partie.
|
|
|
Elle permet également de consulter les scores de chaque joueur pour chaque partie.
|
|
|
Le projet est développé en C# avec le framework .NET Core 6.0.
|
|
|
la documentation de l'API est disponible à l'adresse suivante : https://codefirst.iut.uca.fr/swagger/index.html
|
|
|
et est constituée de 2 API (API RestFull et GraphQL) qui qui sont manager par une API Gateway.
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
### Requirements
|
|
|
|
|
|
* C# 10.0
|
|
|
* .NET Core 6.0
|
|
|
* Visual Studio 2022
|
|
|
* Entity Framework Core 6.0
|
|
|
* SQLite 3.36.0
|
|
|
* xUnit 2.4.1
|
|
|
|
|
|
### Clone
|
|
|
|
|
|
Clone this repo to your local machine using 'https://codefirst.iut.uca.fr/git/victor_perez.ngounou/ApiBowlingProject.git'
|
|
|
|
|
|
* [Git](https://git-scm.com) - Download and Install Git.
|
|
|
* [Visual Studio](https://visualstudio.microsoft.com/fr/) - Download and Install Visual Studio.
|
|
|
* [SQLite](https://www.sqlite.org/index.html) - Download and Install SQLite.
|
|
|
* [xUnit](https://xunit.net/) - Download and Install xUnit.
|
|
|
* [Entity Framework Core](https://docs.microsoft.com/fr-fr/ef/core/) - Download and Install Entity Framework Core.
|
|
|
|
|
|
### Install Entity Framework Core Tools
|
|
|
|
|
|
```shell
|
|
|
$ dotnet tool install --global dotnet-ef
|
|
|
```
|
|
|
|
|
|
### Setup
|
|
|
|
|
|
* Ouvrir le projet dans Visual Studio.
|
|
|
|
|
|
#### pour l'API Gateway
|
|
|
* Configurer l'exécution de l'application en mode "Multiple startup projects" et sélectionner les projets suivants :
|
|
|
* BowlingApi: RestFull
|
|
|
* Bowling Api Gateway
|
|
|
* GraphQL Project: GraphQL
|
|
|
* Build le projet.
|
|
|
* L'application est prête à être utilisée.
|
|
|
|
|
|
#### pour l'API RestFull
|
|
|
* Configurer l'exécution de l'application en mode "Multiple startup projects" et sélectionner les projets suivants :
|
|
|
* BowlingApi: Https
|
|
|
* Build le projet.
|
|
|
* L'application est prête à être utilisée.
|
|
|
|
|
|
#### pour l'API GraphQL
|
|
|
* Configurer l'exécution de l'application en mode "Multiple startup projects" et sélectionner les projets suivants :
|
|
|
* GraphQL Project: GraphQL
|
|
|
* Build le projet.
|
|
|
* L'application est prête à être utilisée.
|
|
|
|
|
|
## Requêtes GraphQL
|
|
|
url:
|
|
|
```shell
|
|
|
https://localhost:7197/graphql/
|
|
|
```
|
|
|
|
|
|
### Créer un joueur
|
|
|
|
|
|
```graphql
|
|
|
mutation Addjoueur{
|
|
|
addjoueur (input: {
|
|
|
pseudo:"dadada"
|
|
|
}){
|
|
|
joueur {
|
|
|
pseudo
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
### Récupérer tous les joueurs
|
|
|
|
|
|
```graphql
|
|
|
query GetJoueur{
|
|
|
joueurs{
|
|
|
id
|
|
|
pseudo
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
## Requêtes RestFull
|
|
|
|
|
|
Client RestFull utilisé : Postman
|
|
|
|
|
|
lien de la collection : [Collection postman](https://codefirst.iut.uca.fr/git/victor_perez.ngounou/ApiBowlingProject/src/branch/main/Documentation/Requète%20pour%20excécuter%20et%20tester%20l%27api%20ResFull.postman_collection.json)
|
|
|
url swagger local :
|
|
|
```url
|
|
|
https://localhost:7097/swagger/index.html
|
|
|
```
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
* Open the solution in Visual Studio 2022
|
|
|
* Build the solution
|
|
|
* Run the application
|
|
|
|
|
|
## Contributeurs
|
|
|
|
|
|
* [Victor Perez NGOUNOU](https://codefirst.iut.uca.fr/git/victor_perez.ngounou)
|
|
|
* [Mamadou Elaphi ARAFA](https://codefirst.iut.uca.fr/git/mamadou_elaphi.arafa)
|
|
|
|
|
|
|
|
|
## Support
|
|
|
|
|
|
Contactez-moi à l'un des endroits suivants !
|
|
|
|
|
|
* Website at <a href="https://codefirst.iut.uca.fr/git/victor_perez.ngounou" target="_blank">`https://codefirst.iut.uca.fr/git/victor_perez.ngounou`</a>
|
|
|
* Email at <a href="mailto:victor_perez.ngounou@etu.uca.fr" target="_blank">`victor_perez.ngounou@etu.uca.fr`</a>
|
|
|
|
|
|
## License
|
|
|
|
|
|
[](https://codefirst.iut.uca.fr/sonar/dashboard?id=BowlingScoreApp)
|
|
|
|
|
|
- **[MIT license](http://opensource.org/licenses/mit-license.php)** |
