간단하게 말하면, API가 명세되어있는 oas를 받아서 타입이나 API 함수를 자동 생성하는 툴이다.

라이브러리가 한 두개가 아니다. 찾아보고 잘 골라야한다. 유명하지 않은 라이브러리는 잘 작동하지 않는 경우가 많다는 경험을 해봤기 때문에.

https://openapi-generator.tech/

아마도 여기가 제일 괜찮은 것 같다. 문서화도 깔끔하게 되어있다.

CLI Installation 항목으로 들어가서 위와 같이 실행해준다.

팀프로젝트인만큼 다른 팀원들도 사용할 수 있을거라 생각하여 3번 라인으로 프로젝트 내에 설치해준다.

그리고 이제 대망의 실행 명령어가 적혀있는 4번째 라인인데…

npx @openapitools/openapi-generator-cli generate -i <https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml> -g ruby -o /tmp/test/

명령어를 차근차근 톺아보면,

• -o 뒤에는 결과물이 저장될 디렉토리가 들어간다.

• -g 뒤에는 어떤 타입으로 저장할지? generator을 설정할 수 있다.

  https://openapi-generator.tech/docs/generators

  여기에 generator 종류가 모두 명세되어있다.

  나의 경우에는 typescript-axios를 사용하였는데..

  

  저렇게 친절하게 -g 뒤에 붙이라고 써있다 !