Skip to content
Yuriy Samsonov edited this page Nov 9, 2016 · 12 revisions

Работа с аккаунтами

Регистрация нового аккаунта

POST /api/account

Передаем параметры в JSON:

{
  "email":"yuriy.samsonov96@gmail.com", // required
  "login":"academeg", // required
  "password":"1234", // required
  "name":"Юрий",
  "surname":"Самсонов"
}

доступно: всем

Редактирование аккаунта

PUT /api/account/{uuid}

Передаем параметры в JSON:

{
  "login":"academeg", // required
  "name":"Юрий",
  "surname":"Самсонов"
}

Можем редактировать только login, name, surname, если они будут пустыми, то они затрутся в базе.

доступно: только авторизованному пользователю, можем редактировать только свой аккаунт

Удаление профиля

DELETE /api/account/{uuid}

доступно: только авторизованному пользователю (который может удалить только себя, либо админ может удалить кого угодно)

Получение информации об аккаунте

GET /api/account/{uuid}

доступно: всем

Получение информации о всех аккаунтах постранично

GET /api/account?page={page}&size={size}

page необязательный параметр, изначально равен 0
size необязательный параметр, изначально равен 20

доступно: всем

Работа с аватарками

Установка аватара

POST /api/account/avatar

Параметры:
image передаем изображение

доступно: только авторизованному пользователю

Удаление аватара

DELETE /api/account/avatar

доступно: только авторизованному пользователю

Получение аватара

GET /api/avatar/{name}

name thumbnailPath или originalPath

доступно: только авторизованному пользователю

Работа с тегами

Создание нового тега

POST /api/tag

Передаем параметры в JSON:

{
  "value": "фотки" // required
}

доступно: авторизованным пользователям

Редактирование тега

PUT /api/tag/{uuid}

Передаем параметры в JSON:

{
  "value": "фотки" // required
}

доступно: админу или модератору

Удаление тега

DELETE /api/tag/{uuid}

доступно: админу или модератору

Получение всех тегов постранично

GET /api/tag?page={page}&size={size}

page необязательный параметр, изначально равен 0
size необязательный параметр, изначально равен 20

доступно: всем

Работа со статьями

Создание новой статьи

POST /api/article

Передаем параметры в JSON:

{
  "title":"Тайтл", // required
  "text":"Текст", // required
  "tags": [
    {
      "id":"fa627258-2b24-4a2e-b437-f2ec6977c95b" // required
    }
  ],
  "images": [
    {
      "id":"82ffdb43-dc83-449a-9f11-cabefb377cb2" // required
    }
  ]
}

доступно: авторизованным пользователям

Редактирование статьи

PUT /api/article/{uuid}

Передаем параметры в JSON:

{
  "title":"Тайтл", // required
  "text":"Текст", // required
  "tags": [
    {
      "id":"fa627258-2b24-4a2e-b437-f2ec6977c95b" // required
    }
  ],
  "images": [
    {
      "id":"82ffdb43-dc83-449a-9f11-cabefb377cb2" // required
    }
  ]
}

images при передачи пустого массива, изображения не удалятся, если передается не пустой массив, то эти изображения добавятся статье
tags если будет пустой массив, то теги удалятся

доступно: автору статьи

Clone this wiki locally