OpenAPI 스펙에서 클라이언트 생성
OpenAPI 스펙의 info.title을 플러그인 ID로 설정하고 생성을 실행하면, 저장소의 src/schema/openapi/generated 폴더에 DefaultApiClient를 포함한 타입이 지정된 클라이언트 코드가 자동 생성돼요.
출처: 문서
본문
repo-tools package schema openapi generate client로 클라이언트를 어떻게 생성하나요?
사전 준비
- OpenAPI 파일의
info.title을 플러그인 ID로 설정하세요. 이렇게요.
info: # your pluginId title: catalog
- 생성된 클라이언트를 담을 새 플러그인을 찾거나 만드세요. 현재는 완전히 새로운 플러그인을 생성하는 것을 지원하지 않고, 단지 클라이언트 파일만 생성해요.
클라이언트 생성
yarn backstage-repo-tools package schema openapi generate --client-package <directory>를 실행하세요. 그러면<directory>/src/schema/openapi/generated에 생성된 콘텐츠를 담을 새 폴더가 만들어져요.src/schema/openapi/generated상위 폴더의 하위 폴더에서 어떤 것도 import할 필요가 없어요. 필요한 모든 것은src/schema/openapi/generated/index.ts파일에서 접근할 수 있어요. 핵심 항목은 다음과 같아요.DefaultApiClient- 특정 스펙에 접근할 때 사용할 수 있는 클라이언트예요.- 모든 요청·응답 타입 - index에서 사용할 수 있으며, 스펙의 이름과 일치해야 해요.