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