Skip to content
swagger-to-tanstack-query

문제 해결

코드 생성 시 가장 흔히 발생하는 문제들의 해결 방법.

흔한 문제와 그 해결 방법입니다.

”swagger-to-tanstack-query.config.json not found”

전체 에러 메시지는 [config] swagger-to-tanstack-query.config.json not found in <dir>입니다. 파일 이름은 정확히 swagger-to-tanstack-query.config.json이어야 하며, 명령어를 실행하는 디렉터리에 있어야 합니다.

Swagger UI URL만 있는 경우

기계가 읽을 수 있는 스펙은 별도 경로로 제공됩니다. springdoc(Spring Boot)에서는 보통 https://<host>/v3/api-docs입니다. 브라우저에서 열었을 때 JSON이 보인다면, 그 주소가 바로 url입니다.

스펙 URL에 인증이 걸려 있는 경우

스펙 엔드포인트가 로그인, 베이직 인증, 베어러 토큰 뒤에 있으면 생성기가 직접 받아올 수 없습니다. 스펙을 로컬 파일로 내려받은 뒤 url이 그 파일을 가리키게 하세요 — url은 URL뿐 아니라 로컬 경로도 받습니다.

Terminal window
# 베어러 토큰
curl -H "Authorization: Bearer <token>" https://<host>/v3/api-docs -o ./swagger.json
# 또는 베이직 인증
curl -u <user>:<pass> https://<host>/v3/api-docs -o ./swagger.json
{
  "url": "./swagger.json",
  "output": "./src/api",
  "client": { "path": "@/lib/axios", "name": "axiosInstance" }
}

벗겨낸 뒤 data가 T | undefined인 경우

스펙에서 엔벨롭의 data 필드가 선택적이므로, 벗겨낸 타입도 선택적이 됩니다. data?.x로 좁히거나 API에서 해당 필드를 필수로 표시하세요. Response Envelope를 참고하세요.

컨트롤러 이름이 default인 경우

해당 operation들은 스펙에 tags가 없습니다. 태그를 추가해 그룹으로 묶으세요.

import가 @/…를 쓰는데 해석되지 않는 경우

client.path/error.path는 그대로 기록됩니다. tsconfig.json의 paths(그리고 번들러)가 해당 alias를 정의하고 있는지 확인하세요. Configuration을 참고하세요.

관련 문서