/NotePadServerAPI

Backend development for RTUITLab level 1. Yanovsky Vladislav Valerievich IKBO-01-19.

Primary LanguageC#

NotePadServerAPI

Описание - суть, идея, замысел

Backend: ASP.NET Core

Database: MySQL

Сервис "Покупки", который может хранить данные о покупках разных людей.

О покупке необходимо хранить следующую информацию:

  • Дата покупки
  • Название товара
  • Сумму, потраченную на товар

Необходима базовая концепция аутентификации. Например, можно передавать ID человека, про которого запрашивается/отправляется информация через строку запроса, или заголовок.

На данном уровне подразумевается, что сервис является "записной книжкой", в которую человек может поместить информацию о своих покупках.

Было создано:

  • Модели пользователя и покупки
  • Два контроллера для пользователей и их покупок, где отслеживались поступающие запросы
  • Два класса DAO для взаимодействия контроллеров с БД
  • Контекст для БД
  • Swagger документация
  • Postman тесты
  • Unit тесты
  • Dockerfile
  • docker-compose.yml

Инструкция по запуску

Можно запустить на Windows.

Нужны: Docker Desktop, Visual Studio

Для запуска нужно скачать проект и зайти через cmd в папку проекта (там где находится docker-compose файл). В консоли ввести следующие команды:

docker-compose pull
docker-compose up -d

После открываем любой браузер и вводим в поле для ссылок:

localhost:8080/swagger

Там можно будет познакомиться с документацией и попробовать отправить запросы.

Или же вручную, примеры:

localhost:8080/api/users
localhost:8080/api/users/{userId}
localhost:8080/api/users/{userId}/{purchaseId}

Ссылки

Видео

Dockerhub repo

Postman tests