net.n2oapp.security.admin.rest.api.UserRestService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of security-admin-rest-api Show documentation
There is a newer version: 8.0.1
Show newest version
/*
 * Copyright 2017-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.n2oapp.security.admin.rest.api;

import io.swagger.annotations.*;
import net.n2oapp.security.admin.api.model.Password;
import net.n2oapp.security.admin.api.model.User;
import net.n2oapp.security.admin.api.model.UserForm;
import net.n2oapp.security.admin.api.model.UserRegisterForm;
import net.n2oapp.security.admin.rest.api.criteria.RestUserCriteria;
import org.springframework.data.domain.Page;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import java.util.Map;

/**
 * REST сервис управления пользоватлями
 */
@Path("/users")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@Api(value = "Пользователи", authorizations = @Authorization(value = "oauth2"))
public interface UserRestService {

    @GET
    @Path("/")
    @ApiOperation("Найти всех пользователей")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Страница пользователей")
    })
    Page findAll(@BeanParam RestUserCriteria criteria);

    @GET
    @Path("/{id}")
    @ApiOperation("Получить пользователя по идентификатору")
    @ApiResponse(code = 200, message = "Пользователь")
    User getById(@ApiParam(value = "Идентификатор") @PathParam("id") Integer id);

    @POST
    @Path("/")
    @ApiOperation("Создать пользователя")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Созданный пользователь"),
            @ApiResponse(code = 400, message = "Неккоректный запрос. Отсутвуют обязательные поля или заполнены некорректными данными")
    })
    User create(@ApiParam(value = "Пользователь") UserForm user);

    @POST
    @Path("/register")
    @ApiOperation("Регистрация пользователя")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Зарегистрированный пользователь"),
            @ApiResponse(code = 400, message = "Неккоректный запрос. Отсутвуют обязательные поля или заполнены некорректными данными")
    })
    User register(@ApiParam(value = "Пользователь") UserRegisterForm user);

    @PUT
    @Path("/")
    @ApiOperation("Изменить пользователя")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Измененный пользователь"),
            @ApiResponse(code = 400, message = "Неккоректный запрос. Отсутвуют обязательные поля или заполнены некорректными данными")
    })
    User update(@ApiParam(value = "Пользователь") UserForm user);

    /**
     * Частичное обновление данных. Ожидает на вход мапу по своей структуре сходную
     * с моделью UserForm.
     *
     * @see UserForm
     */

    @PATCH
    @Path("/")
    @ApiOperation("Изменить пользователя (частично)")
    @ApiResponse(code = 200, message = "Измененный пользователь")
    User patch(@ApiParam(value = "Пользователь") Map userForm);

    @DELETE
    @Path("/{id}")
    @ApiOperation("Удалить пользователя")
    @ApiResponse(code = 200, message = "Пользователь удален")
    @ApiResponses({
            @ApiResponse(code = 204, message = "Пользователь удален"),
            @ApiResponse(code = 400, message = "Неккоректный запрос. Пользователь не найден или вы пытаетесь удалить самого себя")
    })
    void delete(@ApiParam(value = "Идентификатор") @PathParam("id") Integer id);

    @PUT
    @Path("/changeActive/{id}")
    @ApiOperation("Изменить статус пользователя")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Пользователь с измененным статусом"),
            @ApiResponse(code = 400, message = "Неккоректный запрос. Отсутвуют обязательные поля или заполнены некорректными данными")
    })
    User changeActive(@ApiParam(value = "Идентификатор") @PathParam("id") Integer id);

    @GET
    @Path("/simpleDetails")
    @ApiOperation("Загрузить простейшую информацию о пользователе (имя, почта и временный пароль)")
    @ApiResponse(code = 200, message = "Временный пароль")
    User loadSimpleDetails(@ApiParam(value = "Идентификатор") @QueryParam("id") Integer id);

    @PUT
    @Path("/resetPassword")
    @ApiOperation("Сбросить пароль")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Пароль сброшен"),
            @ApiResponse(code = 400, message = "Неккоректный запрос. Отсутвуют обязательные поля или заполнены некорректными данными")
    })
    void resetPassword(@ApiParam(value = "Пользователь") UserForm user);

    @POST
    @Path("/generatePassword")
    @ApiOperation("Сгенерировать пароль")
    @ApiResponses({@ApiResponse(code = 200, message = "Пароль")})
    Password generatePassword();
}