Class DtoInterfaceBuilder

Builds a TypeScript interface for an object schema.

public class DtoInterfaceBuilder : DtoBuilder

Inherited Members: DtoBuilder.Identifier

DtoBuilder.Schema

DtoBuilder.Naming

DtoBuilder.TypeNames

DtoBuilder.ChildTypes

DtoBuilder.For(string, OpenApiSchema, INamingStrategy, TypeNameRegistry)

DtoBuilder.BuildTypes()

Constructors

Builds a TypeScript interface for an object schema.

public DtoInterfaceBuilder(string key, OpenApiSchema schema, INamingStrategy naming, TypeNameRegistry? typeNames = null)

key string: The key identifying the schema.
schema OpenApiSchema: The schema to generate a type for.
naming INamingStrategy: Decides what the generated type is called.
typeNames TypeNameRegistry: Keeps the names of types generated for inline schemas from colliding with other generated types.

The properties of this type, including any merged in from inline allOf schemas.

protected readonly IReadOnlyDictionary<string, OpenApiSchema> Properties

The keys of the required properties, including any from inline allOf schemas.

protected readonly ICollection<string> RequiredProperties

Builds a property, keeping the exact key used on the wire as its name.

protected virtual TsProperty BuildProperty(string key, OpenApiSchema? schema)

Builds the type for Schema, without the parts common to all kinds of DTO.

protected override ITsType BuildTypeInner()