@ApiImplicitParam 이란

 

 

@ApiImplicitParam

 

@ApiImplicitParam은 Swagger 문서화를 위해 사용되는 애노테이션

즉, API의 매개변수를 설명하고 문서화하는 데 사용된다.

@ApiImplicitParam은 다음과 같은 속성을 가진다.

-   `name`: 매개변수의 이름을 지정
-   `value`: 매개변수에 대한 설명을 지정
-   `dataType`: 매개변수의 데이터 타입을 지정
-   `paramType`: 매개변수의 유형을 지정합니다. `path`, `query`, `header`, `body`, `form` 등의 값을 가질 수 있음
-   `defaultValue`: 매개변수의 기본값을 지정
-   `allowMultiple`: 매개변수를 여러 개의 값으로 허용할지 여부를 지정
-   `required`: 매개변수가 필수인지 여부를 지정
-   `example`: 매개변수의 예시 값을 지정

@ApiImplicitParam을 사용하여 API 메서드의 매개변수를 설명하면, Swagger UI에서 해당 매개변수에 대한 정보가 표시된다.

이때 사용자는 API 호출 시 필요한 매개변수의 형식, 설명, 기본값 등을 쉽게 확인할 수 있다.

예제

@ApiImplicitParam을 사용하여 `name`이라는 경로 변수를 설명하는 예제를 참고해보자

 

@GetMapping("/users/{name}")
@ApiOperation("Get user by name")
@ApiImplicitParam(name = "name", value = "User's name", dataType = "String", paramType = "path")
public User getUserByName(@PathVariable String name) {
    // 사용자 정보를 조회하고 반환
}

위의 예제에서 `@ApiImplicitParam` 애노테이션은 `name` 매개변수를 설명한다.

이를 통해 Swagger 문서화에서 사용자가 `name` 경로 변수를 어떻게 제공해야 하는지에 대한 정보를 제공한다.