net.n2oapp.security.admin.rest.api.RoleRestService 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.Role;
import net.n2oapp.security.admin.api.model.RoleForm;
import net.n2oapp.security.admin.rest.api.criteria.RestRoleCriteria;
import org.springframework.data.domain.Page;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;

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

    @GET
    @Path("/")
    @ApiOperation("Найти роли по критериям поиска")
    @ApiResponse(code = 200, message = "Страница ролей")
    Page findAll(@BeanParam RestRoleCriteria criteria);

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

    @POST
    @Path("/")
    @ApiOperation("Создать роль")
    @ApiResponse(code = 200, message = "Созданная роль")
    Role create(@ApiParam(value = "Роль") RoleForm role);

    @PUT
    @Path("/")
    @ApiOperation("Изменить роль")
    @ApiResponse(code = 200, message = "Измененная роль")
    Role update(@ApiParam(value = "Роль") RoleForm role);

    @DELETE
    @Path("/{id}")
    @ApiOperation("Удалить роль")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Роль удалена"),
            @ApiResponse(code = 404, message = "Роль не найдена")
    })
    void delete(@ApiParam(value = "Идентификатор") @PathParam("id") Integer id);
}