anguage: Russian Perflib | English

1. Конечно же скачать сам докер (с этим возможно могут быть проблемы на винде)
2. В папке проекта открыть командную строку и ввести: docker build -t gorse-perflib .
3. После того как оно закончило собирать образ, нужно ввести: docker run -d -p 8050:8050 gorse-perflib. Это запустит приложение на фоне

Чтобы остановить образ: docker image ls, найти "IMAGE_ID" и ввести docker container stop "IMAGE_ID" Если надо будет удалить образ (по каким-либо причинам), то нужно ввести: docker image ls, найти "IMAGE ID" нужного образа и ввести docker image rm "IMAGE_ID" --force

В случае если захочется самому запустить на своей машине это всё дело, можно глянуть в сам докерфайл

Сервис на 0.0.0.0 адрес по дефолту (localhost/www), так что сервер может быть даже открытым для интернета, если порты открыты на хосте.

Все эндпоинты которые выдают что-то имеют параметр number, в котором можно указать кол-во возвращаемого результата К примеру: localhost:8050/popular?number=1 выдаст самый популярный предмет (и только один), если number=2 то первые 2 и т.д

В сервис можно засовывать как и id, так и string имена юзеров/предметов, но feedback (далее будет об этом) принимает только string во всех параметрах. К примеру, нельзя сделать параметр ItemId при добавлении предмета/юзера int-овым, будет ошибка. Скорее всего позже я это пофикшу как будет возможность

Все JSON идут в множественном формате (как принимающие, так и отправляющие), т.е они все оборачиваются в []

user-id может быть как и строка, так и id, не имеет разницы Формат возвращаемого json:

          {
             "ItemId":"string",
             "Popularity": int, 
             "Timestamp": "instant"
             "Score": int
          }

P.S: Popularity, может быть > 1, пока не уверен что float Timestamp пока что не разобрался зачем нужен, так что лучше игнорьте (формат его: 0001-01-01T00:00:00Z)

Score это число от 0 до 1, float, представляет из себя счёт конкретной рекомендации для конкретного пользователя

Здесь есть одна оссобенность, юзер добавляется сразу вместе с сущностью которую он открыл То есть, нельзя добавлять юзера без сущности Формат добавления через json:

     {
         "UserId":"id",
         "ItemId":"id",
         "Feedback":float,
     }

P.S Feedback может быть больше 0, float'ом и как я понял, если мы говорим о просмотрах пользователя, это кол-во добавляемых просмотров пользователя.

так как оно даёт одинаковые результаты, но оно выдаёт сущности в таком же формате что и рекомендации

выдаёт результаты в том же формате что и эндпоинт рекомендаций

формат вывода json:

   [
   	"user1",
   	"user2",
   	"..."
   ]

формат вывода json:

    [
         {
             "UserId":"username",
             "ItemId":"id",
             "Rating": int
         }
    ]

P.S Rating и представляет из себя feedback, здесь он выдаётся в формате int

формат вывода json:

    [
             {
                 "ItemId":"id",
                 "Popularity": int,
                 "Timestamp": "instant"
            }
    ]

В сервисе ещё остались парочку эндпоинтов, но думаю для начала хватит и этих

Если понадобятся другие, то можно глянуть на них в файле cmd/rest.go