/TasksApi

Апи для тестовых заданий.

Primary LanguageJavaScript

*Описание Tasks Api

Для запуска сервера Tasks Api необходимо выполнить следующие действия:

  1. Установить Node.js версии 6+ (https://nodejs.org/dist/v6.3.0/node-v6.3.0-x64.msi);
  2. Запустить Node.js Command Prompt;
  3. Перейти в каталог приложения TasksApi;
  4. Выполнить команду "npm install" (загружает необходимые модули в каталог приложения) и дождаться её завершения;
  5. Выполнить команду "npm start".

Если все сделано верно, то Tasks Api будет доступно по адресу http://localhost:8080/ При запуске будут созданы тестовые данные; запущен обработчик, постепенно выполняющий задачи.

Адрес Метод Описание Параметры
api/tasks/types GET Возвращает список типов заданий.
api/tasks?name={name}&typeId={typeId}&statusCode={statusCode}&from={from}&to={to}&skip={skip}&take={take} GET Возвращает список заданий.
Если указаны параметры skip и take, то дополнительно вернется общее количество заданий		 Опциональные параметры:
  • {name} — фильтр по названию задания;
  • {typeId} — фильтр по типу задания (может быть множественным);
  • {statusCode} — фильтр по статусу задания (может быть множественным);
  • {from} — фильтр по дате создания, начиная с даты;
  • {to} — фильтр по дате создания, заканчивая датой;
  • {skip} — количество заданий, которое необходимо пропустить;
  • {take} — количество заданий, которое необходимое выбрать.
api/tasks POST
  • Создает новое задание;
  • Возвращает id задания.
  • name — название задания;
  • typeId — идентификатор типа задания.
api/tasks/{id} GET Возвращает задание. {id} — идентификатор задания.
api/tasks/{id} DELETE Удаляет задание. {id} — идентификатор задания.
api/tasks/{id} PUT Обновляет задание.
  • {id} — идентификатор задания;
  • name — название задания;
  • typeId — идентификатор типа задания.