FileServer

Файловый сервер

Репозиторий содержит API для простого файлового сервера и интеграционных тестов для API.

Начните:

0. Установите Docker
1. START SERVER (execute run.bat)
   • Шаг запустит Docker Compose, который установит MongoDB и запустит API.
   • Примечание. Если у вас есть проблема с сертификатами на этом этапе - попробуйте запустить решение в Visual Studio с Docker Compose (см. Ниже), он установит сертификат. После этого run.bat также будет работать.
2. Убедитесь, что API работает (Open: https: // localhost: 44348/swagger).
3. Запустить интеграционные тесты (execute test.bat)
   • В конце вы увидите путь к тестированию журналов в вашей консоли

Как отлаживать API с Visual Studio?

Есть два варианта:

1. Без докера
   • Установите MongoDB или используйте MongoDB, установленную в разделе. Начало начало (файл конфигурации уже содержит строку подключения для локальной базы данных).
   • Установите Fileserver.api как проект запуска.
   • Используйте один из двух вариантов.
   • Нажмите F5.
2. С Docker Compose
   • Убедитесь, что контейнеры начинаются в разделе . Начало работы остановлены. (В противном случае у вас будут проблемы с контейнерами во время отладки.).
   • Установите Docker-Compose как проект стартапа.
   • Нажмите F5.

Где найти apikeys?

Вы можете использовать любой из APIKES из конфигураций, чтобы получить доступ к API. ПРИМЕЧАНИЕ. Введите префикс -ключ с ApiKey , например, ApiKey 123 .

Как отлаживать интеграционные тесты?

• Убедитесь, что API файлового сервера работает.
• Убедитесь, что конфигурации содержит правильный URL -адрес для API File Server.
• Интеграционные тесты, реализованные на основе спекфалоу. Поэтому я бы посоветовал вам установить расширение для Visual Studio для лучшего опыта использования.
• Вы можете найти тестовые сценарии в папке функций
• После того, как решение будет открыто в Visual Studio и создано, вы можете запускать тесты в качестве модульных тестов Standart. Тест-> запустить все тесты.

Что было реализовано?

• Restful API для загрузки/загрузки документов и управления метаданными.
• Web API возвращает значимые коды статуса HTTP для всех случаев
• Кэширование на стороне сервера
• Интеграционные тесты на основе Speckflow BDD.
• Dockerfile с Docker Compose
• Настраиваемая журнала для входящих запросов HTTP
• Отслеживание версий и корреляции API
• Механизм аутентификации, основанный на Apikey.
• SPA нет клиента, но https: // localhost: 44348/swagger позволяет загружать/загружать документы и проверять все функциональные возможности, доступные в API.

Что не было реализовано?

• Для больших файлов я бы добавил API, который позволит загружать файлы в куски.
• Я бы добавил конечную точку проверки здоровья.