개발자가 AWS API Gateway의 크기 제한 문제를 해결하기 위해 YAML 파일의 불필요한 요소를 제거하는 yaml-scraper npm 모듈을 개발했다

Context

저자는 Swagger를 사용하여 API 문서 사이트를 자동 생성하는 환경에서 작업한다. Amazon API Gateway로 Swagger 파일을 import할 때 크기 제한 에러가 발생했다.

Technical Solution

• yaml-scraper npm 패키지를 개발하여 YAML 파일의 크기를 줄였다
• delete() 메서드로 특정 키 요소를 삭제한다
• empty() 메서드로 특정 키의 값을 빈 문자열로 대체한다
• deleteParent() 메서드로 특정 요소의 부모 요소를 제거한다
• 메서드 체인 방식으로 delete().empty().deleteParent() 연결한다
• 모든 중첩 깊이에서 작동한다

Impact

Amazon API Gateway의 파일 크기 제한을 우회하여 Swagger 문서를 성공적으로 import할 수 있게 되었다

Key Takeaway

특정 플랫폼의 제한 조건을 해결하기 위해 목적에 맞는 도구를 직접 개발하면 실무 문제를 효과적으로 해결할 수 있다