مولد OpenAPI·AsyncAPI خاص بـ Node فقط مفصول عن وقت تشغيل المتصفح.
مولد OpenAPI·AsyncAPI مخصص لـ Node فقط، مفصول عن وقت تشغيل المتصفح.
تصديرات وحدة OpenAPI
DEFAULT_OPTIONS
OpenAPI generator의 기본 옵션 객체입니다.
mergeOptions
기본 옵션과 사용자 옵션을 병합합니다.
parseServerSentEvent
SSE event의 data 필드를 JSON object로 파싱합니다.
parseJsonResponseText
HTTP 응답 문자열을 JSON object로 파싱합니다.
connectToSwaggerEventStream
SSE watcher를 시작하고 close() handle을 반환합니다.
generateSwaggerFromHttp
plain JSON GET one-shot 생성.
generateSwaggerFromFile
local file one-shot 생성.
requestJsonOnce
옵션에 맞춰 HTTP(S) JSON을 한 번 가져옵니다.
handleSwaggerData
받은 Swagger object를 저장하고 types, union arrays, services 생성 단계로 전달합니다.
createOpenApiTypescriptCommand
설정된 package와 경로를 기준으로 openapi-typescript 실행 명령을 구성합니다.
generateTypes
openapi-typescript process를 실행합니다.
generateUnionArrays
enum/union 후보를 apiUnionArrays.ts로 생성합니다.
generateSwaggerServices
paths에서 서비스와 schema alias 파일을 생성합니다.
خيارات OpenAPI الافتراضية
| Name | Type | Default | الوصف |
|---|---|---|---|
hostname | string | localhost | backend host. |
port | number | 8123 | backend port. |
path | string | /for-local/get-swagger | Swagger endpoint. |
method | string | GET | Swagger endpoint 요청 method. |
headers | Record<string, string> | { Accept: "text/event-stream" } | EventStream watcher 기본 요청 헤더. |
serviceDir | string | ./src/handler/service | 서비스 출력 폴더. |
swaggerFile | string | ./swagger.json | 원본 JSON 저장 경로. |
typesDir | string | ./src/handler/service/@types | 서비스별 타입 출력 폴더. |
typesFile | string | ./src/handler/service/@types/ApiTypes.d.ts | openapi-typescript 출력 파일. |
unionArraysFile | string | ./src/handler/service/apiUnionArrays.ts | union array 출력 파일. |
commonServiceFile | string | ./src/handler/service/commonService.ts | 생성 서비스가 callApi/callApiStream/cache wrapper를 import할 프로젝트 소유 HTTP adapter 파일입니다. 파일명은 자유롭고 생성기가 만들거나 덮어쓰지 않습니다. 전체 예제는 HTTP Client/OpenAPI Generator 가이드에 있습니다. |
openApiTypescriptCommand | string | null | null | openapi-typescript 실행 명령 전체를 직접 지정합니다. |
openApiTypescriptPackage | string | openapi-typescript@latest | 기본 npx 실행 환경에서 사용할 openapi-typescript package입니다. |
openApiTypescriptTypescriptPackage | string | null | OpenAPI 생성 단계의 격리된 npx 환경에서 함께 사용할 TypeScript package입니다. | |
reconnectDelayMs | number | 10000 | watcher 재접속 지연. |
generateServices | boolean | true | 서비스 생성 여부. |
generateUnionArraysFile | boolean | true | union array 생성 여부. |
keepAlive | boolean | true | CLI watcher process 유지 timer. |
log | Console | console | generator 로그 출력 객체. |
تصديرات وحدة AsyncAPI RSocket
DEFAULT_OPTIONS
AsyncAPI RSocket generator의 기본 옵션 객체입니다.
mergeOptions
기본 옵션과 사용자 옵션을 병합합니다.
parseServerSentEvent
SSE event의 data 필드를 JSON object로 파싱합니다.
parseJsonResponseText
HTTP 응답 문자열을 JSON object로 파싱합니다.
requestJsonOnce
옵션에 맞춰 HTTP(S) JSON을 한 번 가져옵니다.
connectToAsyncApiRSocketEventStream
AsyncAPI SSE watcher.
generateAsyncApiRSocketFromHttp
plain JSON GET one-shot 생성.
generateAsyncApiRSocketFromFile
local AsyncAPI file one-shot 생성.
generateAsyncApiTypes
schemas와 channels를 TypeScript source 문자열로 변환합니다.
writeAsyncApiTypes
AsyncAPI type file을 typesFile 경로에 저장합니다.
handleAsyncApiRSocketData
받은 AsyncAPI object를 저장하고 types와 services 생성 단계로 전달합니다.
generateAsyncApiRSocketServices
controller/destination별 RSocket 서비스와 request/response alias를 생성합니다.
خيارات AsyncAPI الافتراضية
| Name | Type | Default | الوصف |
|---|---|---|---|
hostname | string | localhost | backend host. |
port | number | 8123 | backend port. |
path | string | /for-local/get-asyncapi-rsocket | AsyncAPI endpoint. |
method | string | GET | AsyncAPI endpoint 요청 method. |
headers | Record<string, string> | { Accept: "text/event-stream" } | EventStream watcher 기본 요청 헤더. |
serviceDir | string | ./src/handler/service | RSocket 서비스 출력 폴더. |
asyncApiRSocketFile | string | ./asyncapi-rsocket.json | 원본 JSON 저장 경로. |
typesDir | string | ./src/handler/service/@types | 서비스별 타입 출력 폴더. |
typesFile | string | ./src/handler/service/@types/AsyncApiTypes.ts | 통합 AsyncAPI 타입 파일. |
commonRSocketServiceFile | string | ./src/handler/service/rsoketCommonService.ts | 생성 서비스가 callRSocketMono/callRSocketStream을 import할 프로젝트 소유 RSocket adapter 파일입니다. 생성기가 만들거나 덮어쓰지 않습니다. 전체 예제는 RSocket & AsyncAPI 가이드에 있습니다. |
reconnectDelayMs | number | 10000 | watcher 재접속 지연. |
generateServices | boolean | true | 서비스 생성 여부. |
keepAlive | boolean | true | CLI watcher process 유지 timer. |
log | Console | console | generator 로그 출력 객체. |