Пользователь

Описание структуры JSON-объекта, описывающего пользователя

Поле Тип Описание
id string Уникальный ID пользователя
username string Псевдоним пользователя
name string Имя пользователя
surname string Фамилия пользователя
fullName string Полное имя пользователя
avatar string Ссылка на аватар пользователя
cover string Ссылка на фон пользователя

Ознакомиться со структурой JSON-объекта, описывающего проект можно здесь

Метод для получения списка всех пользователей

GET /user

Запрос возвращает массив пользователей, есть возможность настройки количества отображаемых объектов на странице

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "userList": [
            {
                "id": "7cda0fdc-aaaa-aaaa-aaaa-6b0bfe8bbddf",
                "username": "user1",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/4427cf28-aaaa-aaaa-aaaa-8ee5e6b3a467.jpg",
                "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
            },
            {
                "id": "166e63d7-aaaa-aaaa-aaaa-e46b43e29c21",
                "username": "user2",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/197869df-aaaa-aaaa-aaaa-d2442372699c.jpg",
                "cover": "/upload/img/33fxd0r1-aaaa-aaaa-aaaa-9e7er56jtdbb.jpg"
            },
            {
                "id": "03105a7f-aaaa-aaaa-aaaa-e87cd6ee60b2",
                "username": "user3",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/17e7bcfe-aaaa-aaaa-aaaa-aabce41d7259.jpg",
                "cover": "/upload/img/23d7g0d1-aaaa-aaaa-aaaa-tf45gd7ftd6b.jpg"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 3,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения текущего пользователя

GET /user/me

Запрос возвращает текущего пользователя

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "id": "fbc3d462-aaaa-aaaa-aaaa-6990c978d786",
    "username": "user1",
    "name": "name",
    "surname": "surname",
    "fullName": "name surname",
    "avatar": "https://gitflic.ru/upload/img/2731a61f-aaaa-aaaa-aaaa-a5ac13429653.jpg",
    "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения пользователя по псевдониму

GET /user/{userAlias}

Запрос возвращает пользователя

Переменная пути запроса Тип Описание
userAlias string Псевдоним пользователя

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "id": "fbc3d462-aaaa-aaaa-aaaa-6990c978d786",
    "username": "user2",
    "name": "name",
    "surname": "surname",
    "fullName": "name surname",
    "avatar": "https://gitflic.ru/upload/img/2731a61f-aaaa-aaaa-aaaa-a5ac13429653.jpg",
    "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения публичных проектов пользователя

GET /user/{userAlias}/projects

Запрос возвращает публичные проекты пользователя

Переменная пути запроса Тип Описание
userAlias String Псевдоним пользователя

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "_embedded": {
        "projectList": [
            {
                "id": "f3f322a8-aaaa-aaaa-aaaa-9b163a505a79",
                "title": "test-project",
                "description": "",
                "alias": "test-project",
                "ownerAlias": "test",
                "httpTransportUrl": "https://gitflic.ru/project/test/test-project.git",
                "sshTransportUrl": "git@gitflic.ru:test/test-project.git",
                "language": "Markdown",
                "selectorTitle": "test-project",
                "private": false,
                "selectorOwnerAlias": "test",
                "selectorId": "f3f322a8-aaaa-aaaa-aaaa-9b163a505a79",
                "selectorAlias": "test-project",
                "isDeleted": false,
                "hexColor": null,
                "selectorColor": null,
                "selectorHash": null
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения подписчиков пользователя

GET /user/{userAlias}/followers

Запрос возвращает подписчиков пользователя

Переменная пути запроса Тип Описание
userAlias string Псевдоним пользователя

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "content": [
        {
            "name": Name,
            "id": 1,
            "fullName": "Name Surname",
            "avatar": "/upload/img/6ebb3414-aaaa-aaaa-aaaa-e250f5c5d80c.jpg",
            "username": "test",
            "company": null,
            "surname": Surname,
            "createdAt": "2023-03-07T15:21:49.405942",
            "registrationDateString": "7 марта 2023 г.",
            "subscribed": false
        }
    ],
    "pageable": {
        "sort": {
            "empty": false,
            "unsorted": false,
            "sorted": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 12,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalElements": 1,
    "totalPages": 1,
    "size": 12,
    "number": 0,
    "sort": {
        "empty": false,
        "unsorted": false,
        "sorted": true
    },
    "first": true,
    "numberOfElements": 1,
    "empty": false
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Метод для получения подписок пользователя

GET /user/following/{userAlias}

Запрос возвращает пользователей, на которых подписан указанный пользователь

Переменная пути запроса Тип Описание
userAlias string Псевдоним пользователя

Responses

STATUS 200 пример JSON:

Пример ответа 
    
{
    "content": [
        {
            "name": Name,
            "id": 1,
            "fullName": "Name Surname",
            "avatar": "/upload/img/6ebb3414-aaaa-aaaa-aaaa-e250f5c5d80c.jpg",
            "username": "test",
            "company": null,
            "surname": Surname,
            "createdAt": "2023-03-07T15:21:49.405942",
            "registrationDateString": "7 марта 2023 г.",
            "subscribed": false
        }
    ],
    "pageable": {
        "sort": {
            "empty": false,
            "unsorted": false,
            "sorted": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 12,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalElements": 1,
    "totalPages": 1,
    "size": 12,
    "number": 0,
    "sort": {
        "empty": false,
        "unsorted": false,
        "sorted": true
    },
    "first": true,
    "numberOfElements": 1,
    "empty": false
}


STATUS 403 - Нет прав для доступа.

STATUS 404 - Данные по запросу не найдены.

Навигация