feat : 스웨거 동적 예시값 생성 (#99)

[ImNM]

개요

• close 🚀 [feature] 동적으로 스웨거 응답 예시값 생성 (에러 코드 기반) #99
  

요런걸 없앴슴니다

작업사항

• 동적으로 스웨거 응답값 생성 하도록 지정했습니다.

• 원래 예시값 적을때 json 형식으로 말도안되게 귀찮게 하는데 그런걸 없앴씁니다
  

• api 하나마다 ( 적어주고싶은 중요한 에러가 있을시 )

@ExceptionDoc
public class ExampleExceptionDocs {

    @ExplainError("유저검색시에 안나올 때 나오는 에러입니다.")
    public DuDoongCodeException 유저없을때 = UserNotFoundException.EXCEPTION;

    @ExplainError("오더 낫파운드")
    public DuDoongCodeException 한글도된다 = OrderNotFoundException.EXCEPTION;

    @ExplainError("인밸리드 오더")
    public DuDoongCodeException 오류가났을때 = InvalidOrderException.EXCEPTION;
}

@GetMapping
    @DevelopOnlyApi
    @ApiErrorExample(ExampleExceptionDocs.class)
    public ExampleResponse get() {
        return exampleApiService.getExample();
    }

위와같은방법으로 ApiErrorExample 에 타입정도 넘기시면 자동으로 예시값 생성됩니다.
ExplainError 어노테이션으로 추가부가설명을 적을 수있습니다.
어떠어떠할때 오류가 생성된다~ 그런식으로 기술하면됩니다~

변경로직

• 내용을 적어주세요.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
143 Code Smells

7.2% Coverage
0.0% Duplication

[cofls6581]

굳굳 작업 공유 감사함둥 LGTM!

[sanbonai06]

LGTM