FileServer

Dateiserver

Das Repository enthält eine API für einen einfachen Dateiserver und Integrationstests für die API.

Beginnen Sie an:

0. Docker installieren
1. Server starten (run.bat ausführen)
   • Mit dem Schritt wird Docker Compose ausgeführt, mit dem MongoDB installiert und die API ausgeführt wird.
   • HINWEIS: Wenn Sie in diesem Schritt ein Problem mit Zertifikaten haben, versuchen Sie, die Lösung in Visual Studio mit Docker Compose auszuführen (siehe unten), das Erfordernis des Zertifikats. Danach wird auch run.bat funktionieren.
2. Stellen Sie sicher, dass die API in Betrieb ist (Open: https: // localhost: 44348/Swagger).
3. Integrationstests ausführen (test.bat)
   • Am Ende sehen Sie Pfad zum Testen von Protokollen in Ihrer Konsole

Wie debugge ich API mit Visual Studio?

Es gibt zwei Optionen:

1. Ohne Docker komponieren
   • Installieren Sie MongoDB oder verwenden Sie MongoDB, die im Abschnitt "Erste" installiert sind (die Konfigurationsdatei enthält bereits eine Verbindungszeichenfolge für die lokale Datenbank).
   • Setzen Sie FileServer.api als Startprojekt.
   • Verwenden Sie eine von zwei Optionen.
   • Drücken Sie F5.
2. Mit Docker komponieren
   • Stellen Sie sicher, dass die Container im Abschnitt Start gestoppt werden. (Andernfalls haben Sie während des Debugs Probleme mit Containern.)
   • Setzen Sie Docker-Compose als Startprojekt.
   • Drücken Sie F5.

Wo finden Sie Apikeys?

Sie können APIKEYS aus Konfigurationen verwenden, um Zugriff auf die API zu erhalten. HINWEIS: Geben Sie beispielsweise ApiKey 123 ein wichtiges Schlüssel ein, das mit ApiKey vorangestellt ist.

Wie debugge ich Integrationstests?

• Stellen Sie sicher, dass die Dateiserver -API in Betrieb ist.
• Stellen Sie sicher, dass die Konfigurationen eine ordnungsgemäße URL für Datei -Server -API enthält.
• Integrationstests basierend auf Speckflow. Ich würde Ihnen also empfehlen, eine Erweiterung für Visual Studio für eine bessere Nutzungserfahrung zu installieren.
• Sie können Testszenarien im Funktionsordner finden
• Sobald die Lösung in Visual Studio geöffnet und erstellt wurde, können Sie Tests als Standart -Unit -Tests ausführen. Test-> Alle Tests ausführen.

Was wurde implementiert?

• RESTful -API zum Hochladen/Herunterladen von Dokumenten und Verwaltung von Metadaten.
• Die Web -API gibt aussagekräftige HTTP -Statuscodes für alle Fälle zurück
• Serverseite Caching
• Integrationstests basierend auf BDD Speckflow.
• Dockerfile mit Docker Compose
• Konfigurierbare Protokollierung für HTTP -Eingangsanforderungen
• API -Versioning und Korrelationsverfolgung
• Authentifizierungsmechanismus basierend auf Apikey.
• Es gibt keinen SPA -Client, aber https: // localhost: 44348/Swagger ermöglicht das Hochladen/Herunterladen von Dokumenten und das Testen aller in der API verfügbaren Funktionen.

Was wurde nicht implementiert?

• Für große Dateien würde ich eine API hinzufügen, mit der Dateien in Stücken hochgeladen werden können.
• Ich würde den Endpunkt der Gesundheitsprüfung hinzufügen.