Refitter.SourceGenerator 0.7.0.20-preview

Additional Details

The generated Refit interface is not picked up by Refit so RestService.For<T>() fails to resolve the interface. See https://github.com/christianhelle/refitter/issues/100

This is a prerelease version of Refitter.SourceGenerator.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Refitter.SourceGenerator --version 0.7.0.20-preview                
NuGet\Install-Package Refitter.SourceGenerator -Version 0.7.0.20-preview                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Refitter.SourceGenerator" Version="0.7.0.20-preview">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Refitter.SourceGenerator --version 0.7.0.20-preview                
#r "nuget: Refitter.SourceGenerator, 0.7.0.20-preview"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Refitter.SourceGenerator as a Cake Addin
#addin nuget:?package=Refitter.SourceGenerator&version=0.7.0.20-preview&prerelease

// Install Refitter.SourceGenerator as a Cake Tool
#tool nuget:?package=Refitter.SourceGenerator&version=0.7.0.20-preview&prerelease                

NuGet

Refitter Source Generator

A C# Source Generator that uses Refitter for generating a REST API Client using the Refit library. Refitter can generate the Refit interface from OpenAPI specifications

Installation

The source generator is distributed as a NuGet package and should be installed to the project that will contain the generated code

dotnet add package Refitter.SourceGenerator

Usage

This source generator generates code based on any .refitter file included to the project as AdditionalFiles.

The generator can automatically detect all .refitter files inside the project that referenced the Refitter.SourceGenerator package and there is no need to include them manually as AdditionalFiles

File format

{
  "openApiPath": "/path/to/your/openAPI", // Required
  "namespace": "Org.System.Service.Api.GeneratedCode", // Optional. Default=GeneratedCode
  "naming": {
    "useOpenApiTitle": false, // Optional. Default=true
    "interfaceName": "MyApiClient" // Optional. Default=ApiClient
  },
  "generateContracts": true, // Optional. Default=true
  "generateXmlDocCodeComments": true, // Optional. Default=true
  "addAutoGeneratedHeader": true, // Optional. Default=true
  "returnIApiResponse": false, // Optional. Default=false
  "generateOperationHeaders": true, // Optional. Default=true
  "typeAccessibility": "Public", // Optional. Values=Public|Internal. Default=Public
  "useCancellationTokens": false, // Optional. Default=false
  "useIsoDateFormat": false, // Optional. Default=false
  "additionalNamespaces": [ // Optional
    "Namespace1",
    "Namespace2"
  ]
}
  • openApiPath - points to the OpenAPI Specifications file. This can be the path to a file stored on disk, relative to the .refitter file. This can also be a URL to a remote file that will be downloaded over HTTP/HTTPS
  • namespace - the namespace used in the generated code. If not specified, this defaults to GeneratedCode
  • naming.useOpenApiTitle - a boolean indicating whether the OpenApi title should be used. Default is true
  • naming.interfaceName - the name of the generated interface. The generated code will automatically prefix this with I so if this set to MyApiClient then the generated interface is called IMyApiClient. Default is ApiClient
  • generateContracts - a boolean indicating whether contracts should be generated. A use case for this is several API clients use the same contracts. Default is true
  • generateXmlDocCodeComments - a boolean indicating whether XML doc comments should be generated. Default is true
  • addAutoGeneratedHeader - a boolean indicating whether XML doc comments should be generated. Default is true
  • returnIApiResponse - a boolean indicating whether to return IApiResponse<T> objects. Default is false
  • generateOperationHeaders - a boolean indicating whether to use operation headers in the generated methods. Default is true
  • typeAccessibility - the generated type accessibility. Possible values are Public and Internal. Default is Public
  • useCancellationTokens - Use cancellation tokens in the generated methods. Default is false
  • useIsoDateFormat - Set to true to explicitly format date query string parameters in ISO 8601 standard date format using delimiters (for example: 2023-06-15). Default is false
  • additionalNamespaces - A collection of additional namespaces to include in the generated file. A use case for this is when you want to reuse contracts from a different namespace than the generated code. Default is empty
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.0

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Refitter.SourceGenerator:

Repository Stars
christianhelle/refitter
A tool for generating Refit interfaces and contracts from OpenAPI specifications
Version Downloads Last updated
1.5.0-preview.65 61 a month ago
1.5.0-preview.64 47 a month ago
1.5.0-preview.63 50 a month ago
1.4.1 3,233 2 months ago
1.4.1-preview.62 54 2 months ago
1.4.0 4,987 3 months ago
1.4.0-preview.61 46 3 months ago
1.3.2 1,551 3 months ago
1.3.2-preview.60 50 3 months ago
1.3.1 571 4 months ago
1.3.0 1,609 4 months ago
1.2.1-preview.59 61 4 months ago
1.2.1-preview.58 134 4 months ago
1.2.1-preview.57 69 4 months ago
1.2.1-preview.56 59 4 months ago
1.2.1-preview.55 58 4 months ago
1.2.1-preview.54 56 4 months ago
1.2.0 3,114 5 months ago
1.2.0-preview.53 43 5 months ago
1.2.0-preview.52 54 5 months ago
1.1.3 20,511 6 months ago
1.1.3-preview.51 55 6 months ago
1.1.2 24,841 6 months ago 1.1.2 is deprecated because it has critical bugs.
1.1.2-preview.50 50 6 months ago
1.1.2-preview.49 65 6 months ago
1.1.1 187,370 6 months ago
1.1.1-preview.48 55 6 months ago
1.1.1-preview.47 62 6 months ago
1.1.1-preview.46 64 6 months ago
1.1.0.45-preview 101 6 months ago
1.0.2 237,821 7 months ago
1.0.1 48,506 7 months ago
1.0.0 246,667 8 months ago
0.9.9.44-preview 84 8 months ago
0.9.9 10,369 3/7/2024
0.9.8 2,095 2/27/2024
0.9.7 73,386 2/7/2024
0.9.6 289 1/29/2024
0.9.5 33,714 1/15/2024
0.9.4.43-preview 161 1/15/2024
0.9.4 32,175 1/12/2024
0.9.3.42-preview 153 1/10/2024
0.9.2 20,217 1/10/2024
0.9.1 4,157 1/9/2024
0.9.0 8,651 1/9/2024
0.8.7.41-preview 164 1/3/2024
0.8.7.40-preview 241 12/20/2023
0.8.7 59,375 12/18/2023
0.8.6.39-preview 447 12/14/2023
0.8.6.38-preview 143 12/14/2023
0.8.6 10,417 12/11/2023
0.8.5 675 11/23/2023
0.8.4 823 11/7/2023
0.8.3 218 10/31/2023
0.8.2 2,421 10/9/2023
0.8.1 234 10/4/2023
0.8.0 7,975 9/23/2023
0.7.5 215 9/7/2023
0.7.4 199 9/6/2023
0.7.3.37-preview 258 8/25/2023
0.7.3.36-preview 165 8/25/2023
0.7.3.35-preview 221 8/21/2023
0.7.3.34-preview 198 8/15/2023
0.7.3.33-preview 337 8/12/2023
0.7.3 891 8/26/2023
0.7.2.32-preview 296 8/7/2023 0.7.2.32-preview is deprecated because it has critical bugs.
0.7.2 275 8/7/2023 0.7.2 is deprecated because it has critical bugs.
0.7.1.31-preview 288 8/2/2023 0.7.1.31-preview is deprecated because it has critical bugs.
0.7.1.30-preview 282 8/2/2023 0.7.1.30-preview is deprecated because it has critical bugs.
0.7.1.29-preview 180 8/1/2023 0.7.1.29-preview is deprecated because it has critical bugs.
0.7.1 249 8/3/2023 0.7.1 is deprecated because it has critical bugs.
0.7.0.28-preview 246 7/28/2023 0.7.0.28-preview is deprecated because it has critical bugs.
0.7.0.27-preview 255 7/28/2023 0.7.0.27-preview is deprecated because it has critical bugs.
0.7.0.26-preview 262 7/27/2023 0.7.0.26-preview is deprecated because it has critical bugs.
0.7.0.23-preview 272 7/27/2023 0.7.0.23-preview is deprecated because it has critical bugs.
0.7.0.22-preview 248 7/27/2023 0.7.0.22-preview is deprecated because it has critical bugs.
0.7.0.21-preview 214 7/27/2023 0.7.0.21-preview is deprecated because it has critical bugs.
0.7.0.20-preview 224 7/27/2023 0.7.0.20-preview is deprecated because it has critical bugs.
0.7.0 183 7/31/2023 0.7.0 is deprecated because it has critical bugs.
0.6.3.10 208 7/26/2023 0.6.3.10 is deprecated because it has critical bugs.
0.6.3.9 187 7/26/2023 0.6.3.9 is deprecated because it has critical bugs.
0.6.3.8 278 7/26/2023 0.6.3.8 is deprecated because it has critical bugs.
0.6.3.7-preview 242 7/26/2023 0.6.3.7-preview is deprecated because it has critical bugs.
0.6.3.6-preview 209 7/26/2023 0.6.3.6-preview is deprecated because it has critical bugs.
0.6.3.5-preview 259 7/26/2023 0.6.3.5-preview is deprecated because it has critical bugs.
0.6.3.4-preview 255 7/26/2023 0.6.3.4-preview is deprecated because it has critical bugs.