FileServer

Serveur de fichiers

Le référentiel contient une API pour un serveur de fichiers simple et des tests d'intégration pour l'API.

Commencer:

0. Installer Docker
1. Démarrer le serveur (exécuter run.bat)
   • L'étape exécutera Docker Compose qui installera MongoDB et exécutera l'API.
   • Remarque: Si vous avez un problème avec les certificats sur cette étape - essayez d'exécuter la solution dans Visual Studio avec Docker Compose (voir ci-dessous), il installera le certificat exige. Après cette run.bat fonctionnera également.
2. Assurez-vous que l'API est opérationnelle (ouvert: https: // localhost: 44348 / swagger).
3. Exécutez des tests d'intégration (exécuter test.bat)
   • À la fin, vous verrez le chemin du chemin pour tester les journaux de votre console

Comment déboguer API avec Visual Studio?

Il y a deux options:

1. Sans docker composé
   • Installez MongoDB ou utilisez MongoDB installé dans la section Démarrage (le fichier de configuration contient déjà une chaîne de connexion pour la base de données locale).
   • Définissez FileServer.API comme projet de démarrage.
   • Utilisez l'une des deux options.
   • Appuyez sur F5.
2. Avec Docker Compose
   • Assurez-vous que les conteneurs commencés dans la section commencent . (Sinon, vous aurez des problèmes avec les conteneurs pendant le débogage.).
   • Définissez Docker-Compose comme projet de démarrage.
   • Appuyez sur F5.

Où trouver des apikeys?

Vous pouvez utiliser l'un des Apikeys à partir de configurations pour accéder à l'API. Remarque: entrez une clé préfixée avec ApiKey par exemple ApiKey 123 .

Comment déboguer les tests d'intégration?

• Assurez-vous que l'API du serveur de fichiers est opérationnel.
• Assurez-vous que les configurations contiennent une API URL du serveur de fichiers appropriée.
• Tests d'intégration implémentés sur la base de SpeckFlow. Je vous suggère donc d'installer une extension pour Visual Studio pour une meilleure expérience d'utilisation.
• Vous pouvez trouver des scénarios de test dans le dossier des fonctionnalités
• Une fois la solution ouverte dans Visual Studio et construite, vous pouvez exécuter des tests sous forme de tests unitaires. Test-> Exécutez tous les tests.

Qu'est-ce qui a été mis en œuvre?

• API RESTFul pour télécharger / télécharger des documents et gérer les métadonnées.
• L'API Web renvoie des codes d'état HTTP significatifs pour tous les cas
• Cache côté serveur
• Tests d'intégration basés sur BDD SpeckFlow.
• Dockerfile avec docker compose
• Journalisation configurable pour les demandes entrantes HTTP
• Versioning API et suivi de corrélation
• Mécanisme d'authentification basé sur Apikey.
• Il n'y a pas de client SPA, mais https: // localhost: 44348 / Swagger permet de télécharger / télécharger des documents et de tester toutes les fonctionnalités disponibles dans l'API.

Qu'est-ce qui n'a pas été mis en œuvre?

• Pour les fichiers volumineux, j'ajouterais une API qui permettra de télécharger des fichiers en morceaux.
• J'ajouterais un point de terminaison de contrôle de la santé.