v0.8.1

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.8.1

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports OpenAPI specification validation and error/warning/stats reporting
• Supports generating route, query, header, and body request parameters
• Generate code at build time using rosyln C# source generator Refitter.SourceGenerator
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)
• --multiple-interfaces CLI tool argument to generate a Refit interface for each endpoint. This may be either ByEndpoint or ByTag
• --settings-file CLI tool argument to use a .refitter format file and override all other arguments
• --skip-validation CLI tool argument to ignore all validation errors and attempt to generate code anyway
• --match-path CLI tool argument to only include Paths that match the provided regular expression. May be set multiple times
• --tag CLI tool argument to only include Endpoints that contain this tag. May be set multiple times and result in OR'ed evaluation
• --optional-nullable-parameters CLI tool argument to make non-required query parameters to optional parameters in Refit interface
• --operation-name-template CLI tool argument to append a prefix or suffix to the {operationName} template

What's Changed

• Add matchPath option in example .refitter file in README by @christianhelle in #146
• Skip default values when collecting feature usages for Analytics by @christianhelle in #145
• Fix documentation regarding --settings-file usage by @christianhelle in #152
• Disable support keys if --no-logging is specified by @christianhelle in #153
• Mark deprecated operations by @angelofb in #154
• Update docs with details about --no-deprecated-operations by @christianhelle in #155
• Speed up local smoke tests by @christianhelle in #156
• Generate Refit interfaces as partial by @christianhelle in #162
• Optional OpenAPI Path in CLI arguments by @christianhelle in #160
• Introduce --operation-name-template command line argument by @angelofb in #164
• Add support for optional parameters via the --optional-nullable-parameters CLI argument by @christianhelle in #163
• Update .refitter file format documentation by @christianhelle in #169
• Allow for custom relative output path in .refitter by @Noblix in #172
• Resolved issues reported by @Ekkeir , @waylonmtz , @vinaymadupathi

Full Changelog: 0.7.5...0.8.1

v0.8.0

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.8.0

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports OpenAPI specification validation and error/warning/stats reporting
• Supports generating route, query, header, and body request parameters
• Generate code at build time using rosyln C# source generator Refitter.SourceGenerator
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)
• --multiple-interfaces CLI tool argument to generate a Refit interface for each endpoint. This may be either ByEndpoint or ByTag
• --settings-file CLI tool argument to use a .refitter format file and override all other arguments
• --skip-validation CLI tool argument to ignore all validation errors and attempt to generate code anyway
• --match-path CLI tool argument to only include Paths that match the provided regular expression. May be set multiple times
• --tag CLI tool argument to only include Endpoints that contain this tag. May be set multiple times and result in OR'ed evaluation
• --optional-nullable-parameters CLI tool argument to make non-required query parameters to optional parameters in Refit interface
• --operation-name-template CLI tool argument to append a prefix or suffix to the {operationName} template

What's Changed

• Add matchPath option in example .refitter file in README by @christianhelle in #146
• Skip default values when collecting feature usages for Analytics by @christianhelle in #145
• Fix documentation regarding --settings-file usage by @christianhelle in #152
• Disable support keys if --no-logging is specified by @christianhelle in #153
• Mark deprecated operations by @angelofb in #154
• Update docs with details about --no-deprecated-operations by @christianhelle in #155
• Speed up local smoke tests by @christianhelle in #156
• Generate Refit interfaces as partial by @christianhelle in #162
• Optional OpenAPI Path in CLI arguments by @christianhelle in #160
• Introduce --operation-name-template command line argument by @angelofb in #164
• Add support for optional parameters via the --optional-nullable-parameters CLI argument by @christianhelle in #163
• Update .refitter file format documentation by @christianhelle in #169
• Resolved issues reported by @Ekkeir , @waylonmtz , @vinaymadupathi

Full Changelog: 0.7.5...0.8.0

v0.7.5

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.7.5

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports OpenAPI specification validation and error/warning/stats reporting
• Supports generating route, query, header, and body request parameters
• Generate code at build time using rosyln C# source generator Refitter.SourceGenerator
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)
• --multiple-interfaces CLI tool argument to generate a Refit interface for each endpoint. May be one of ByEndpoint, ByTag
• --settings-file CLI tool argument to use a .refitter format file and override all other arguments
• --skip-validation CLI tool argument to ignore all validation errors and attempt to generate code anyway
• --match-path CLI tool argument to only include Paths that match the provided regular expression. May be set multiple times
• --tag CLI tool argument to only include Endpoints that contain this tag. May be set multiple times and result in OR'ed evaluation

What's Changed

• Feature: Filtering of endpoints and tags by @kirides in #132
• Update docs with new --tag and --match-path features by @christianhelle in #134
• Fix issue when downloading an OpenAPI spec from a URL that returns a GZIP stream by @christianhelle in #136
• Show help text if no arguments are passed by @christianhelle in #140
• Introduce OpenAPI validation by @christianhelle in #141
• Fix #142 by changing includeTags filtering and restoring collection snapshots by @kirides in #143

Full Changelog: 0.7.3...0.7.5

v0.7.4

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.7.4

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports OpenAPI specification validation and error/warning/stats reporting
• Supports generating route, query, header, and body request parameters
• Generate code at build time using rosyln C# source generator Refitter.SourceGenerator
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)
• --multiple-interfaces CLI tool argument to generate a Refit interface for each endpoint. May be one of ByEndpoint, ByTag
• --settings-file CLI tool argument to use a .refitter format file and override all other arguments
• --skip-validation CLI tool argument to ignore all validation errors and attempt to generate code anyway
• --match-path CLI tool argument to only include Paths that match the provided regular expression. May be set multiple times
• --tag CLI tool argument to only include Endpoints that contain this tag. May be set multiple times and result in OR'ed evaluation

What's Changed

• Feature: Filtering of endpoints and tags by @kirides in #132
• Fix the issue when downloading an OpenAPI spec from a URL that returns a GZIP stream by @christianhelle in #136
• Show help text if no arguments are passed by @christianhelle in #140
• Introduce OpenAPI validation by @christianhelle in #141

Full Changelog: 0.7.3...0.7.4

v0.7.3

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.7.3

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports generating route, query, header, and body request parameters
• Generate code at build time using rosyln C# source generator Refitter.SourceGenerator
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)
• --multiple-interfaces CLI tool argument to generate a Refit interface for each endpoint. May be one of ByEndpoint, ByTag
• --settings-file CLI tool argument to use a .refitter format file and override all other arguments

What's Changed

• Remove source generator from docs and builds by @christianhelle in #101
• Source Generator Hack - Write to disk instead of the syntax tree by @christianhelle in #102
• Enable SonarCloud by @christianhelle in #103
• Restore source generator in docs and builds by @christianhelle in #104
• Resolve SonarCloud detected code smells by @christianhelle in #105
• docs: add @guillaumeserale as a contributor for bug by @allcontributors in #109
• docs: add @Roflincopter as a contributor for ideas by @allcontributors in #110
• Add Accept Request Header by @guillaumeserale in #108
• Fix issue where [Headers("Accept")] is always generated by @christianhelle in #111
• Bump NSwag.CodeGeneration.CSharp from 13.19.0 to 13.20.0 by @dependabot in #113
• Bump NSwag.Core.Yaml from 13.19.0 to 13.20.0 by @dependabot in #112
• Bump Microsoft.NET.Test.Sdk from 17.7.0 to 17.7.1 by @dependabot in #115
• Bump H.Generators.Extensions from 1.15.1 to 1.16.0 by @dependabot in #114
• Update docs regarding accept headers by @christianhelle in #116
• Bump Microsoft.CodeAnalysis.CSharp from 4.6.0 to 4.7.0 by @dependabot in #117
• Fix duplicate Accept headers by @christianhelle in #119
• Add Codecov workflow and badge by @christianhelle in #120
• docs: add yadanilov19 as a contributor for ideas by @allcontributors in #122
• Exclude from generated code from code coverage by @christianhelle in #123
• Fix parameters' casing in openAPI document are not honoured in Refit interface methods by @christianhelle in #125
• Bump FluentAssertions from 6.11.0 to 6.12.0 by @dependabot in #126
• Add support for using .refitter file from CLI by @christianhelle in #127
• Improve local smoke tests and introduce dev containers support by @christianhelle in #128
• Fix incorrect assembly and file version by @christianhelle in #129

Full Changelog: 0.7.2...0.7.3

v0.7.2

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.7.2

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports generating route, query, header, and body request parameters
• Generate code at compile time using rosyln C# source generator Refitter.SourceGenerator
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)
• --multiple-interfaces CLI tool argument to generate a Refit interface for each endpoint. May be one of ByEndpoint, ByTag

What's Changed

• Add support for generating multiple interfaces by @christianhelle in #93
• Rename source generator output to use .refitter file and replace extension with .g.cs by @christianhelle in #94
• docs: add kirides as a contributor for code by @allcontributors in #96
• Generate Multiple interfaces based on first Tag by @kirides in #95
• Small code cleanup in Generators by @kirides in #97
• Local smoke test bash script by @christianhelle in #98
• Bump Microsoft.NET.Test.Sdk from 17.6.3 to 17.7.0 by @dependabot in #99

New Contributors

• @kirides made their first contribution in #95

Full Changelog: 0.7.0...0.7.2

v0.7.0

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.7.0

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports generating route, query, header, and body request parameters
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)

What's Changed

• check if query parameter is an array by @angelofb in #70
• make use of new language features by @angelofb in #72
• Introduce --use-iso-date-format CLI tool argument by @christianhelle in #73
• Enhanced HTTP status code 200 handling for API responses by @NoGRo in #74
• Fix DirectoryNotFoundException by @christianhelle in #77
• Fix support for spaces in operationId by @christianhelle in #79
• Additonal Namespaces for generated Types by @angelofb in #80
• General improvements on code, docs, and workflows by @christianhelle in #84
• Add .editorconfig by @angelofb in #85
• Introduce C# Source Generator and the .refitter file format in #86
• Add NuGet package icon by @christianhelle in #90

New Contributors

• @angelofb made their first contribution in #70
• @NoGRo made their first contribution in #74
• @brease-colin reported the issues #66 and #68

Full Changelog: 0.5.30...0.7.0

v0.6.3

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.6.3

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports generating route, query, header, and body request parameters
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)

What's Changed

• check if query parameter is an array by @angelofb in #70
• make use of new language features by @angelofb in #72
• Introduce --use-iso-date-format CLI tool argument by @christianhelle in #73
• Enhanced HTTP status code 200 handling for API responses by @NoGRo in #74
• Fix DirectoryNotFoundException by @christianhelle in #77
• Fix support for spaces in operationId by @christianhelle in #79
• Additonal Namespaces for generated Types by @angelofb in #80
• General improvements on code, docs, and workflows by @christianhelle in #84
• Add .editorconfig by @angelofb in #85

New Contributors

• @angelofb made their first contribution in #70
• @NoGRo made their first contribution in #74
• @brease-colin reported the issues #66 and #68

Full Changelog: 0.5.30...0.6.3

v0.6.2

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.6.2

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports generating route, query, header, and body request parameters
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)

What's Changed

• check if query parameter is an array by @angelofb in #70
• make use of new language features by @angelofb in #72
• Introduce --use-iso-date-format CLI tool argument by @christianhelle in #73
• Enhanced HTTP status code 200 handling for API responses by @NoGRo in #74
• Fix DirectoryNotFoundException by @christianhelle in #77
• Fix support for spaces in operationId by @christianhelle in #79
• Additonal Namespaces for generated Types by @angelofb in #80

New Contributors

• @angelofb made their first contribution in #70
• @NoGRo made their first contribution in #74
• @brease-colin reported the issues #66 and #68

Full Changelog: 0.5.30...0.6.2

v0.6.1

Installation

This is packaged as a .NET Tool and is published to nuget.org. You can install this specific version of this tool like this:

dotnet tool install --global Refitter --version 0.6.1

Features

• Generate single file containing Refit interface and contract types from an OpenAPI spec file
• Supports OpenAPI v2 and v3
• Supports OpenAPI specifications in JSON and YAML formats
• Supports generating route, query, header, and body request parameters
• --no-auto-generated-header CLI tool argument to skip prefixing output file with header
• --interface-only CLI tool argument to skip contract type generation
• --use-api-response CLI Tool argument to return IApiResponse<T> instead of Task<T>
• --internal CLI tool argument to generate types with the internal accessibility modifier
• --cancellation-tokens CLI tool argument to generate the Refit interface with CancellationTokens
• --no-operation-headers CLI tool argument to skip generating [Header] parameters
• --no-logging CLI tool argument to disable error logging and feature usage tracking
• --use-iso-date-format CLI tool argument to explicitly format date query string parameters in ISO standard date format using delimiters (2023-06-15)

What's Changed

• check if query parameter is an array by @angelofb in #70
• make use of new language features by @angelofb in #72
• Introduce --use-iso-date-format CLI tool argument by @christianhelle in #73
• Enhanced HTTP status code 200 handling for API responses by @NoGRo in #74
• Fix DirectoryNotFoundException by @christianhelle in #77
• Fix support for spaces in operationId by @christianhelle in #79

New Contributors

• @angelofb made their first contribution in #70
• @NoGRo made their first contribution in #74
• @brease-colin reported the issues #66 and #68

Full Changelog: 0.5.30...0.6.1