@ApiIgnore 어노테이션이란

 

 

@ApiIgnore

Swagger 문서화에서 특정 API를 무시하고 문서에 포함시키지 않도록 지정하는 애노테이션

@ApiIgnore 애노테이션을 사용하면 해당 API가 Swagger 문서에서 제외되며, API 목록, 매개변수, 응답 등에 표시되지 않는다.

 

주로 아래와 같은 상황에서 사용

1.  특정 API를 임시로 사용하지 않을 때

개발 중인 기능이나 테스트 중인 API 등을 임시로 사용하지 않고 문서에 표시하지 않고자 할 때 `@ApiIgnore` 애노테이션을 사용할 수 있다.
    
2.  내부 API 또는 비공개 API

외부에 노출하지 않아야 할 내부 API나 비공개 API의 경우, 문서에 표시하지 않고자 할 때 `@ApiIgnore` 애노테이션을 사용할 수 있다.
    

예를 들어, 아래의 코드는 `@ApiIgnore`를 사용하여 특정 메서드를 Swagger 문서에서 제외시키는 예제이다.

@RestController
public class MyController {

    @ApiOperation("API to get user information")
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        // User 정보를 조회하고 반환
    }

    @ApiIgnore
    @GetMapping("/internal")
    public String internalApi() {
        // 내부 API 로직
    }
}

위의 예제에서 `/internal` 엔드포인트에 `@ApiIgnore` 애노테이션이 부여되었기에 Swagger 문서에서는 해당 API를 무시하고 표시하지 않는다.