Как создать сгруппированные аннотации Swagger - аннотация, запрещенная для этого местоположения - PullRequest
Новая
       6

Как создать сгруппированные аннотации Swagger - аннотация, запрещенная для этого местоположения

1 голос
/ 06 марта 2019

Я хочу сгруппировать эту аннотацию: 

@ApiResponses(value= {
    @ApiResponse(
            code = 200, 
            message = "Successful status response"),
    @ApiResponse(
            code = 400, 
            message = "Successful status response"),
    @ApiResponse(
            code = 500, 
            message = "Successful status response"),

})

в одной аннотации @ResponseCodes, чтобы сократить его. Я нашел этот вопрос SO , который в основном имеет ту же проблему. Решением в этой теме является создание пользовательской аннотации, которая в моем случае выглядела бы так: 

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@ApiResponses(value= {
        @ApiResponse(
                code = 200, 
                message = "Successful status response"),
        @ApiResponse(
                code = 400, 
                message = "Successful status response"),
        @ApiResponse(
                code = 500, 
                message = "Successful status response"),
})

public @interface ResponseCodes {
}

Однако, когда я пытаюсь это сделать, я получаю сообщение об ошибке, @ApiResponses is disallowed in this location.

Есть предложения?

1 Ответ

0 голосов
/ 17 июля 2019

Я решил эту проблему, изменив версию зависимости на 2.9.2, получив следующее: 

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

Результат аннотации: 

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

@ApiResponses(value = {
		@ApiResponse(code = 200, message = STATUS_CODE_200), @ApiResponse(code = 204, message = STATUS_CODE_204),
		@ApiResponse(code = 400, message = STATUS_CODE_400), @ApiResponse(code = 401, message = STATUS_CODE_401),
		@ApiResponse(code = 403, message = STATUS_CODE_403), @ApiResponse(code = 404, message = STATUS_CODE_404),
		@ApiResponse(code = 500, message = STATUS_CODE_500)
})
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WBossResponses {
	
	

}
...