API сервер предоставляющий CRUD операции для сущностей: "категории", "детали", "теги".
Данные хранятся в оперативной памяти и при перезапуске сервера будут сброшены.
- В корне проекта создать файл
docker-compose.override.yml
, скопировать в него содержимое из файлаdocker-compose.override.sample.yml
. - В поле
CORS_ORIGIN
указать адрес веб-приложения, с которого будет происходить обращение к серверу. - Из корня проекта выполнить команду
docker-compose up -d
- API сервер будет доступен по адресу
http://localhost:8080
Поля, у которых в названии присутствует знак вопроса, являются опциональными (пример: parentId?: string;
).
{
id: string;
title: string;
description: string;
parentId?: string;
}
{
title: string;
description: string;
parentId?: string;
}
{
title: string;
description: string;
parentId?: string;
}
{
record: Category;
children: CategoryTreeItem[];
}
{
id: string;
name: string;
code: string;
description?: string;
parentId?: string;
}
{
name: string;
code: string;
description?: string;
parentId?: string;
}
{
name: string;
code: string;
description?: string;
parentId?: string;
}
{
record: Part;
children: PartTreeItem[];
}
{
id: string;
name: string;
active: boolean;
parentId?: string;
}
{
name: string;
active: boolean;
parentId?: string;
}
{
name: string;
active: boolean;
parentId?: string;
}
{
record: Tag;
children: TagTreeItem[];
}
{
message: string;
}
Возвращает массив CategoryTreeItem
Создает новую категорию.
На вход принимает объект NewCategory.
Возвращает объект Category.
Обновляет существующую категорию.
На вход принимает объект UpdateCategory.
Возвращает объект Category.
URL параметры:
{id}
- идентификатор обновляемой категории
Удаляет категорию
URL параметры:
{id}
- идентификатор удаляемой категории
Возвращает массив PartTreeItem
Создает новую деталь.
На вход принимает объект NewPart.
Возвращает объект Part.
Обновляет существующую деталь.
На вход принимает объект UpdatePart.
Возвращает объект Part.
URL параметры:
{id}
- идентификатор обновляемой детали
Удаляет деталь
URL параметры:
{id}
- идентификатор удаляемой деталь
Возвращает массив TagTreeItem
Создает новый тег.
На вход принимает объект NewTag.
Возвращает объект Tag.
Обновляет существующий тег.
На вход принимает объект UpdateTag.
Возвращает объект Tag.
URL параметры:
{id}
- идентификатор обновляемого тега
Удаляет тег
URL параметры:
{id}
- идентификатор удаляемого тега
HTTP статусы ответов:
200
- успешный запрос GET/POST/PUT201
- успешный запрос DELETE400
- ошибка запроса POST/PUT (неверные входные данные)404
- ошибка запроса GET/PUT/DELETE (модель не найдена)500
- внутренняя ошибка сервера
При возникновении ошибок (статусы 400
/404
/500
), в ответ на запрос будет возвращен объект Error.