Skip to main content

GenerateSwaggerApiConfig

Signature

interface GenerateSwaggerApiConfig 

Properties

Property

Modifiers

Type

Description

httpClientType

'axios' | 'fetch'

http client 타입입니다.

includeReactInfiniteQuery

boolean

생성되는 코드의 InfiniteQuery 포함 여부 입니다.

includeReactQuery

boolean

생성되는 코드의 React Query 포함 여부 입니다. 해당 옵션이 false 일경우 infiniteQuery 를 포함한 모든 Query 가 생성되지 않습니다.

instancePath

string

Api 의 axios 혹은 fetch 요청 instance 주소입니다.

output

string

생성될 파일들이 위치할 경로입니다.

paginationSets

PaginationConfig[]

infiniteQuery 를 생성할 함수 필터 목록 입니다.

swaggerSchemaUrl

string

조회할 스웨거의 url 혹은 file(yaml, json) 경로 입니다. 통상적으로 백앤드 개발자에게 공유받은 api-swagger-url 의 '/openapi.json' 경로에 해당합니다.