Skip to content
swagger-to-tanstack-query

프로그래밍 방식 API

CLI 대신 코드에서 직접 생성합니다.

CLI 외에도 generateFromConfig와 generate를 사용해 코드에서 생성기를 직접 구동할 수 있습니다.

사용법

import { generateFromConfig, generate } from "swagger-to-tanstack-query";


// read swagger-to-tanstack-query.config.json from cwd
await generateFromConfig();


// or pass a fully-resolved config
await generate({
  url: "https://api.example.com/v3/api-docs",
  output: "./src/api",
  outputDir: "/abs/path/src/api",
  client: { path: "@/lib/axios", name: "axiosInstance" },
  response: { dataField: "data", envelope: { path: "@/lib/axios", name: "CommonResponse" } },
  error: { path: "@/lib/axios", name: "ApiError" },
  format: true,
});
  • generateFromConfig()는 현재 작업 디렉터리에서 swagger-to-tanstack-query.config.json을 읽습니다. CLI와 동일하게 동작합니다.
  • generate(config)는 절대 경로 outputDir을 포함한, 완전히 해석된 config를 받습니다.

관련 문서