Skip to content

v1.1.3
Compare
Choose a tag to compare
@christianhelle christianhelle released this 19 Jul 11:21
· 411 commits to main since this release
1.1.3
8fac5a9
This commit was signed with the committer’s verified signature.
christianhelle Christian Helle
SSH Key Fingerprint: EqPh7kUAPeYTek89SIGiYiJAoWaVM66LCOreg8gqjL0 Learn about vigilant mode.

What's New

  • Add optional RefitterSettings in generated IoC registration code
  • Introduce --immutable-records CLI tool argument
  • Improve telemetry for --settings-file usage

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 1.1.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 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. This can also be used to customize the Execute() method name in the interfaces generated when --multiple-interfaces ByEndpoint is set
  • --trim-unused-schema CLI tool argument to remove unreferenced components schema to keep the generated output to a minimum
  • --keep-schema CLI tool argument to specify a collection of regular expressions to force to keep matching schema. This is used together with --trim-unused-schema
  • --skip-default-additional-properties CLI tool argument to skip default additional properties
  • --operation-name-generator CLI tool argument to NSwag IOperationNameGenerator implementation to use.
  • --use-observable-response CLI tool argument to return IObservable<T>

Contributions

New Contributors

What's Changed

Full Changelog: 1.1.1...1.1.3

Contributors

christianhelle, bielik01, and 28 other contributors
Assets 2
Loading