TP_DB_Project Осень 2017

API к базе данных проекта «Форумы» по документации к этому API.

Таким образом, на входе:

• документация к API;

На выходе:

• репозиторий, содержащий все необходимое для разворачивания сервиса в Docker-контейнере.

Документация к API

Документация к API предоставлена в виде спецификации OpenAPI: swagger.yml

Документацию можно читать как собственно в файле swagger.yml, так и через Swagger UI (может быть новая версия): https://tech-db-forum.bozaro.ru/

Так же документацию пожно просмотреть в файле swagger.json

Требования к проекту

Проект включает в себя все необходимое для разворачивания сервиса в Docker-контейнере.

При этом:

• файл для сборки Docker-контейнера называеться Dockerfile и располагаеться в корне репозитория;
• реализуемое API доступно на 5000-ом порту по протоколу http;
• реализаци на языке программирования JAVA;

Контейнер будет собираться и запускаться командами вида:

sudo docker build . -t temp1
sudo docker run -p 5000:5000 --name tmp1 temp1

Функциональное и нагрузочное тестирование

Корректность API будет проверяться при помощи автоматического функционального тестирования.

Методика тестирования:

• собирается Docker-контейнер;
• запускается Docker-контейнер;
• запускается скрипт на Go, который будет проводить тестирование;
• останавливается Docker-контейнер.

В текущем каталоге исполняемый файл tech-db-forum.

Запуск функционального тестирования

Для запуска функционального тестирования нужно выполнить команду вида:

./tech-db-forum func -u http://localhost:5000/api -r report.html

Или

./tech-db-forum func --url=http://localhost:5000/api

Заполнение базы и запуск нагрузочного тестирования

Будет собираться из запускаться командами вида:

./tech-db-forum fill --url=http://localhost:5000/api
./tech-db-forum perf --url=http://localhost:5000/api