Verax API EF

Introduction

Bienvenue sur le projet Verax_API_EF, une API RESTful développée spécifiquement pour faciliter la communication entre le site web et l'application Android du projet Verax. Cette interface est conçue pour gérer efficacement les articles, les formulaires, et les utilisateurs.

Technologies

• .NET 8: Le framework utilisé pour développer l'application.
• Entity Framework Core: ORM utilisé pour l'accès et la gestion de la base de données.
• SQL Server: Système de gestion de base de données recommandé (modifiable selon vos préférences).

Configuration requise

• .NET 8.
• Un système de gestion de base de données (par exemple, SQL Server) accessible depuis l'application.
• Un IDE tel que Visual Studio, VS Code avec l'extension C#, ou JetBrains Rider pour le développement.

Installation

1. Cloner le projet : Exécutez git clone https://github.com/votre/repo.git pour cloner le dépôt dans votre espace de travail local.
2. Configurer la base de données : Assurez-vous que votre système de gestion de base de données est configuré et accessible. Modifiez le fichier de configuration de l'application pour pointer vers votre instance de base de données.
3. Restaurer les dépendances : Ouvrez un terminal dans le dossier du projet et exécutez dotnet restore pour restaurer les dépendances nécessaires.
4. Lancer l'application : Exécutez dotnet run dans le dossier contenant le fichier projet (.csproj) pour démarrer l'API.

Utilisation

Après avoir lancé l'API, elle sera accessible via http://localhost:5000 par défaut. Voici quelques exemples de requêtes que vous pouvez effectuer :

• Obtenir des articles : GET /articles
• Ajouter un utilisateurs : POST /user
• Mettre à jour un articles : PUT /article/{id}
• Supprimer un formulaire : DELETE /formulaire/{id}

Problèmes pouvant être rencontrés

Migration

• Lors de la création de la base de données, l'API s'appuie sur une migration incluse dans le projet DbContextLib. Si cette migration est absente, l'API ne fonctionnera pas correctement car la base de données sera vide, entraînant ainsi l'absence de données retournées. En cas de non présence de cette migration, vous devrez décommenter les lignes dans le fichier LibraryContext.cs du projet DbContextLib (aux alentours de la ligne 60), puis exécuter les commandes suivantes :

dotnet ef migrations add mrg1 --project DbContextLib

Tests Console API

• Pour exécuter les tests console de l'API, assurez-vous au préalable que l'API est en cours d'exécution sur votre machine. Il est également crucial de vérifier que le port utilisé par l'application correspond à celui spécifié dans les configurations des tests. Cette vérification garantit que les tests peuvent interagir correctement avec l'API et fournir des résultats fiables.

Equipe de développement