pro.nikolaev.restutils.annotations.swagger.servererrors.ServiceUnavailable Maven / Gradle / Ivy
/*
* Copyright (c) 2024 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 pro.nikolaev.restutils.annotations.swagger.servererrors;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import pro.nikolaev.restutils.dto.ApiError;
import java.lang.annotation.*;
/**
* A convenience annotation that is itself annotated with
* {@link ApiResponse @ApiResponse}.
*
* Methods that carry this annotation will be included in generated
* openApi documentation with predefined HTTP status code 503.
* {@link ResponseBody @ResponseBody} description will be generated
* according to {@link ApiError} schema description and will use
* a predefined example.
*
*
NOTE: {@code @ServiceUnavailable} is processed if annotated method
* is part of properly configured {@link RestController} and
* {@code springdoc-openapi} library.
*
* @author Ilya Nikolaev
* @see ApiResponse
* @see ResponseEntity
* @see RestController
* @see ApiError
* @since 1.0.4
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@ApiResponse(responseCode = "503", description = "Сервис не доступен",
content = @Content(mediaType = MediaType.APPLICATION_JSON_VALUE,
examples = @ExampleObject("""
{
"message": "Сервис не доступен"
}
"""),
schema = @Schema(implementation = ApiError.class)))
@Documented
public @interface ServiceUnavailable {
}