2021년 7월 27일 화요일

swagger codegen 사용시 주의 사항

사용환경

- spring boot + swagger

- swagger codegen

- java



뭐 당연 한 거겠지만 swagger 의 doc 에 정의가 잘못 되어 있으면 생성 했을 때 결과에 문제가 있다.

겪은 문제


1. 서버는 basic auth 를 쓰고 있는데 apiclient 에서  basic auth 를 설정 하고자 하면 애를 먹는다.

   가능은 하지만 뭔가 정석이 아닌것 같고 이상하다.

   이는 apiClient 에서 수정할수 없는 authentication 을 생성하기 때문인데

   본론적인 문제는 doc 에 정의를 안해서 그렇다.

   


      securitySchemas 를 설정해라.


2. 서버에서 return 타입을 설정하지 않아 object 형태로 sdk 가 생성 되고 파싱 과정에서 데이터가 없는것처 럼 보인다. 뭐 당연하겠지만 이것도 doc 이 잘못 생성 되서 그렇다.


느낀점.

이런류의 코드들은 많은 사람들이 공들여 만든 코드다. 실수는 내가 한다. 휴먼 에러는 나다. ㅎㅎ

구글 블로그는 버리자. 코드넣기 힘들다