API

Guide d'installation du projet InTechNet.API

Prérequis

InTechNet.API est l'API sur laquelle est basée le projet InTechNet. Avant de procéder à l'installation, veillez à disposer de:

• .NET Core 3.1

• C# 8.0

• Un IDE tel que VS Code ou Visual Studio 2019

• Un serveur PostgreSQL

Cloner le projet

Commencer par créer une copie locale du répertoire:

~$ git clone https://github.com/pBouillon/InTechNet.API

Si vous souhaitez ajouter vos fonctionnalités pour pouvoir ensuite les proposer, penser à faire un fork du projet avant et à cloner votre fork !

Initialiser le projet

Configurer l'accès à la base de données

Modifiez les informations de connexion à votre base de données dans le fichier appsettings.json, sous la partie ConnectionStrings

InTechNet.Api\InTechNet.Api\appsettings.json

"ConnectionStrings": {
  "InTechNetDatabase": "Host=localhost;Database=InTechNet;Username=postgres;Password=root"
}

Pour modifier les informations relatives à votre environnement de développement, spécifiez les dansInTechNet.Api\InTechNet.Api\appsettings.Development.json

Installer les dépendances

Pour installer les packages NuGet nécessaires au projet, exécutez les commandes suivantes dans un terminal

InTechNet.Api$ cd InTechNet.Api
InTechNet.Api/InTechNet.Api$ dotnet restore

Compiler le projet

Pour compiler le projet, exécutez la commande suivante, toujours dans le dossierInTechNet.Api

InTechNet.Api/InTechNet.Api$ dotnet build

Par défaut, la cible est Debug, pour compiler en Release, ajouter l'option --configuration Release

Lancer l'API

Dans l'exemple suivant, voici comment lancer l'API à partir d'une compilation en mode Release

InTechNet.Api/InTechNet.Api$ dotnet publish --configuration Release
InTechNet.Api/InTechNet.Api$ cd InTechNet.Api/bin/Release/netcoreapp3.1
InTechNet.Api/InTechNet.Api/InTechNet.Api/bin/Release/netcoreapp3.1$ dotnet InTechNet.Api.dll

L'API est ensuite lancée localement et écoute par défaut sur le port 5001. Vous pouvez y accéder via http://localhost:5001. Vous pouvez également accéder au Swagger et à la documentation de l'API sur https://localhost:5001/swagger.

Au lancement, le programme initialisera automatiquement la base de données avec les tables et relations appropriées.

Interface Swagger de l'API