DOCUMENTATION API

Оглавление

Пользователи	Анкеты	Лайки	Дизлайки
Создание юзера	Добавление анкеты	Получение всех лайков юзера с идентификатором	Получение всех дизлайков юзера с идентификатором {id}
Создание пачки юзеров	Получение всех анкет	Получение всех лайков и дизлайков юзера с идентификатором {id}	Добавление дизлайка от {from} к {to}
Получение всех юзеров	Получение анкеты по идентификатору	Добавление лайка от {from} к {to}	Удаление дизлайка от {from} к {to}
Получение юзера по идентификатору	Обновление анкеты	Удаление лайка от {from} к {to}
Получение юзера по юзернейму	Удаление анкеты по идентификатору
Обновление юзера
Удаление юзера по идентификатору
Удаление юзера по юзернейму

Optional	Аутентификация
Рукопожатие	Аутентификация

Аутентификация (/api/auth/)

Аутентификация по логину и паролю

POST address:8080/api/auth/login (public)

body:

{
    "username": "test",
    "password": "test"
}

example response: 200 "{jwtToken}"

Назад

Пользователи (/api/users/)

Создание юзера

POST address:8080/api/user (public)

body:

{
    "username": "test",
    "email": "[email protected]",
    "password": "1234",
    "firstName": "test",
    "lastName": "test"
}

example response: 204 ""

Назад

Создание пачки юзеров

POST address:8080/api/user/batch (private)

body:

example response: 204 ""

Назад

Получение всех юзеров

GET address:8080/api/user (private)

example response:

Назад

Получение юзера по идентификатору

GET address:8080/api/user/{id} (private)

example response:

Назад

Получение юзера по юзернейму

GET address:8080/api/user/username/{username} (private)

example response:

{
    "username": "test",
    "firstName": "",
    "lastName": "",
    "email": "[email protected]",
    "gender": null,
    "birthday": null,
    "description": "",
    "form": {
        "man": false,
        "woman": false,
        "friendship": false,
        "love": false,
        "sex": false,
        "flirt": false
    }
}

Назад

Обновление юзера

PUT address:8080/api/user (private)

body:

{
    "username": "test",
    "firstName": "test",
    "lastName": "test",
    "email": "test",
    "gender": "m/w",
    "birthday": date,
    "description": "test"
}

example response: "User with username: test updated"

Назад

Удаление юзера по идентификатору

DELETE address:8080/api/user/{id} (private)

example response:

Назад

Удаление юзера по юзернейму

DELETE address:8080/api/user/username/{username} (private)

example response:

Назад

Анкеты (/api/forms)

Добавление анкеты

POST address:8080/api/forms/ (private)

body:

{
    "man": true/false,
    "woman": true/false,
    "friendship": true/false,
    "love": true/false,
    "sex": true/false,
    "flirt": true/false
}

example response: 200 "1"

Назад

Получение всех анкет

GET address:8080/api/forms/all (private)

example response:

Назад

Получение анкеты по идентификатору

GET address:8080/api/forms/{id} (private)

example response:

Назад

Обновление анкеты

PUT address:8080/api/forms/ (private)

body:

{
    "man": true/false,
    "woman": true/false,
    "friendship": true/false,
    "love": true/false,
    "sex": true/false,
    "flirt": true/false
}

example response: 204 ""

Назад

Удаление анкеты по идентификатору

DELETE address:8080/api/forms/{id} (private)

example response: 204 ""

Назад

Лайки (/api/user/likes)

Получение всех лайков юзера с идентификатором {id}

GET address:8080/api/user/{id}/likes (optional param = ?outgoing=true/false) (private)

example response:

Назад

Получение всех лайков и дизлайков юзера с идентификатором {id}

GET address:8080/api/user/{id}/likesDislikes (optional param = ?outgoing=true/false) (private)

example response:

Назад

Добавление лайка от {from} к {to}

POST address:8080/api/user/like/from/{from}/to/{to} (private)

example response: `204 ""

Назад

Удаление лайка от {from} к {to}

DELETE address:8080/api/user/like/from/{from}/to/{to} (private)

example response: 204 ""

Назад

Дизлайки (/api/user/dislikes)

Получение всех дизлайков юзера с идентификатором {id}

GET address:8080/api/user/{id}/dislikes (optional param = ?outgoing=true/false) (private)

example response:

Назад

Добавление дизлайка от {from} к {to}

POST address:8080/api/user/dislike/from/{from}/to/{to} (private) -

example response: 204 ""

Назад

Удаление дизлайка от {from} к {to}

DELETE address:8080/api/user/dislike/from/{from}/to/{to} (private) -

example response: 204 ""

Назад

Optional

Рукопожатие с сервером и определение разрешенных адресов, методов и заголовков

OPTIONS address:8080 (public)

Назад

Картинки (/api/users/images)

Гости (/api/users/guests)

Тэги (/api/users/tags)