Table of Contents

Namespace Refitter.Core

Classes

ApizrSettings

Describing how Apizr should be configured. Here are only the common configurations.

CodeGeneratorSettings

CSharp code generator settings

ContentTypeConstants

Constants for content types and HTTP headers.

DependencyInjectionSettings

Dependency Injection settings describing how the Refit client should be configured. This can be used to configure the HttpClient pipeline with additional handlers

DotNetTypeConstants

Constants for .NET type names used in code generation.

FileExtensionConstants

Constants for file extensions used throughout the application.

FilenameConstants

Constants for default file names.

GeneratedCode

Represents generated code with a type name and content.

GeneratorOutput

Represents the output of the code generator containing generated files.

NamingSettings

Configurable settings for naming in the client API

OpenApiDocumentFactory

Creates instances of NSwag.OpenApiDocument from file paths or URLs. Supports loading single documents or merging multiple documents into one.

OutputPlanner

Plans the output file paths for generated Refit code. Supports single-file and multi-file output modes, CLI and settings-file driven generation, and optional rerouting of contracts to a separate output folder.

OutputPlannerAdapter

Adapts the static OutputPlanner methods to the IOutputPlanner interface.

PackageConstants

Constants for package and library names.

PlannedFile

Represents a planned output file with its relative path and generated content.

RefitDocumentFilter

Filters an OpenAPI document by tags and path patterns. Each filter operation returns a new document without mutating the input.

RefitGenerator

Generates Refit clients and interfaces based on an OpenAPI specification.

RefitGeneratorSettings

Provide settings for Refit generator.

RefitterRunner

Encapsulates the shared generation workflow across all distribution forms (CLI, MSBuild, Source Generator). Handles generator creation, code generation, output planning, validation, warning detection, and file writing.

RefitterSettingsLoader

Loads RefitGeneratorSettings from the contents of a .refitter settings file.

RunResult

Represents the result of a RunAsync(RefitGeneratorSettings, IFileWriter?, IValidator?, string?, string?, CancellationToken) invocation.

RunnerDiagnostic

Represents a diagnostic message from a generation run, such as a validation error or warning.

SchemaCleaner

Cleans up the OpenAPI schema by removing unreferenced schemas and handling inheritance hierarchies.

Serializer

Provides methods for serializing and deserializing objects to and from JSON. This serializer is configured to be case-insensitive.

SourceGeneratorFileWriter

Writes planned files to disk with content-equality checking. Skips writing when the file already exists with identical content, avoiding unnecessary disk writes during incremental / design-time builds.

TypenameConstants

Constants for type names used in code generation.

VersionHelper

Helper class to retrieve the version of the Refitter library.

Warning

Represents a user-facing configuration warning message.

XmlDocumentationGenerator

Generator class for creating XML documentation.

Interfaces

ICodeGenerationConfiguration

Configuration for code generation behavior.

IFileWriter

Writes a PlannedFile to disk, creating directories as needed. Each distribution form (CLI, MSBuild, Source Generator) provides its own adapter that integrates with its own reporting/progress pipeline.

INamingConfiguration

Configuration for naming conventions of generated code elements.

IOutputConfiguration

Configuration for where generated output files are placed.

IOutputPlanner

Resolves a GeneratorOutput into a list of PlannedFile instances. Pure logic — no I/O.

IPartitioningConfiguration

Configuration for how operations are partitioned into Refit interfaces.

ISchemaConfiguration

Configuration for schema processing and cleaning.

IValidator

Validates an OpenAPI specification file and returns validation diagnostics and statistics. Each distribution form (CLI, MSBuild, Source Generator) can provide its own adapter.

Enums

ApizrPackages

Enumeration of available Apizr packages.

AuthenticationHeaderStyle

The Authentication header style to use.

CacheProviderType

Enumeration of cache provider types.

CollectionFormat

Collection format defined in https://swagger.io/docs/specification/v2_0/describing-parameters/#array-and-multi-value-parameters

IntegerType

Specifies the .NET type to use for OpenAPI integer types without a format specifier

MappingProviderType

Enumeration of mapping provider types.

MultipleInterfaces

Enum representing the different options for generating multiple Refit interfaces.

OperationNameGeneratorTypes

The NSwag IOperationNameGenerator implementation to use

PropertyNamingPolicy

Controls how generated contract property names are emitted.

TransientErrorHandler

Libraries for handling transient errors

TypeAccessibility

Specifies the accessibility of a type.