Class OpenApiDocumentExtensions

Namespace

TypedRest.CodeGeneration.Java

Assembly

TypedRest.CodeGeneration.Java.dll

Generates Java TypedRest clients for OpenAPI/Swagger documents.

public static class OpenApiDocumentExtensions

Inheritance

object

OpenApiDocumentExtensions

Methods

GenerateJavaDtos(OpenApiDocument, INamingStrategy, TypeNameRegistry?)

Generates Java types for the schemas in doc.

public static IEnumerable<IJvmType> GenerateJavaDtos(this OpenApiDocument doc, INamingStrategy naming, TypeNameRegistry? typeNames = null)

Parameters

doc OpenApiDocument

naming INamingStrategy

typeNames TypeNameRegistry

Returns

IEnumerable<IJvmType>

GenerateTypedRestJava(OpenApiDocument, JavaGenerationOptions, IGenerationLog?, PatternRegistry?, BuilderRegistry?)

Generates the source files of a Java TypedRest client for doc.

public static IEnumerable<IGeneratedFile> GenerateTypedRestJava(this OpenApiDocument doc, JavaGenerationOptions options, IGenerationLog? log = null, PatternRegistry? patterns = null, BuilderRegistry? builders = null)

Parameters

doc OpenApiDocument

The document describing the service.

options JavaGenerationOptions

Options controlling the generation.

log IGenerationLog

Collects messages about aspects of the document that Java cannot express.

patterns PatternRegistry

Controls what is inferred when the document has no x-typedrest extension.

builders BuilderRegistry

Controls what code is emitted for each kind of endpoint.

Returns

IEnumerable<IGeneratedFile>

GenerateTypedRestJavaEndpoints(OpenApiDocument, INamingStrategy, bool, IGenerationLog?, PatternRegistry?, BuilderRegistry?, TypeNameRegistry?)

Generates the endpoint types of a Java TypedRest client for doc, without the DTOs.

public static IEnumerable<IJvmType> GenerateTypedRestJavaEndpoints(this OpenApiDocument doc, INamingStrategy naming, bool withInterfaces = false, IGenerationLog? log = null, PatternRegistry? patterns = null, BuilderRegistry? builders = null, TypeNameRegistry? typeNames = null)

Parameters

doc OpenApiDocument

naming INamingStrategy

withInterfaces bool

log IGenerationLog

patterns PatternRegistry

builders BuilderRegistry

typeNames TypeNameRegistry

Returns

IEnumerable<IJvmType>