@jin-frame/generator-core / models/generators/IJinFrameData / IJinFrameData

Interface: IJinFrameData

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:16

Data structure for jin-frame code generation

This interface represents the complete information needed to generate a jin-frame class from OpenAPI v3 specification. It includes endpoint information, HTTP method configuration, parameters, imports, and inheritance details required for TypeScript code generation.

Properties

endpoint

endpoint: object

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:27

API endpoint configuration Host and pathPrefix are handled through inheritance. Path contains the path-key from OpenAPI v3 document.

host?

optional host: string

API host URL

originPathKey

originPathKey: string

Original path-key from OpenAPI v3 document

path

path: string

Path-key from OpenAPI v3 document converted to pathToRegex format

pathPrefix?

optional pathPrefix: string

Path prefix from server section

---

extends

extends: object

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:87

Base class extension configuration

name

name: string

Base class name to extend

typeArgument

typeArgument: string

Type arguments for the base class

---

imports

imports: object[]

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:79

Import statements required for the generated frame

moduleSpecifier

moduleSpecifier: string

Module path to import from

namedImports

namedImports: string

Named imports from the module

---

method

method: object

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:47

HTTP method configuration

arguments?

optional arguments: IFrameOption

Method decorator options

type

type: "Get" | "Delete" | "Head" | "Link" | "Options" | "Patch" | "Post" | "Purge" | "Put" | "Search" | "Unlink"

HTTP method type

---

name

name: string

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:20

Frame class name

---

parameters

parameters: ({ arguments: IQueryFieldOption; type: "Query"; } | { arguments: IParamFieldOption; type: "Param"; } | { arguments: IHeaderFieldOption; type: "Header"; } | { arguments: IBodyFieldOption; type: "Body"; } | { arguments: IObjectBodyFieldOption; type: "ObjectBody"; })[]

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:55

Field parameter configurations for the frame

---

typeParameters?

optional typeParameters: object[]

Defined in: packages/generator-core/src/models/generators/IJinFrameData.ts:39

Frame type parameter information

default?

optional default: string

Default value for type parameter

name

name: string

Type parameter name