Refitter 0.2.3-alpha
See the version list below for details.
dotnet tool install --global Refitter --version 0.2.3-alpha
dotnet new tool-manifest
dotnet tool install --local Refitter --version 0.2.3-alpha
#tool dotnet:?package=Refitter&version=0.2.3-alpha&prerelease
nuke :add-package Refitter --version 0.2.3-alpha
Refitter
Refitter is a CLI tool for generating a C# REST API Client using the Refit library.
Installation:
The tool is packaged as a .NET Tool and is published to nuget.org. You can install the latest version of this tool like this:
dotnet tool install --global Refitter --prerelease
Usage:
$ refitter --help
USAGE:
refitter [input file] [OPTIONS]
EXAMPLES:
refitter ./openapi.json --namespace "Your.Namespace.Of.Choice.GeneratedCode" --output ./Output.cs
ARGUMENTS:
[input file] Path to OpenAPI Specification file
OPTIONS:
DEFAULT
-h, --help Prints help information
-n, --namespace GeneratedCode Default namespace to use for generated types
-o, --output Output.cs Path to Output file
--no-auto-generated-header Don't add <auto-generated> header to output file
To generate code from an OpenAPI specifications file, run the following:
$ refitter [path to OpenAPI spec file] --namespace "[Your.Namespace.Of.Choice.GeneratedCode]"
This will generate a file called Output.cs
which contains the Refit interface and contract classes generated using NSwag
Here's an example generated output from the Swagger Petstore example
using Refit;
using System.Threading.Tasks;
using System.Collections.Generic;
namespace Your.Namespace.Of.Choice.GeneratedCode
{
public interface ISwaggerPetstore
{
/// <summary>
/// Update an existing pet by Id
/// </summary>
[Put("/pet")]
Task<Pet> UpdatePet([Body]Pet body);
/// <summary>
/// Add a new pet to the store
/// </summary>
[Post("/pet")]
Task<Pet> AddPet([Body]Pet body);
/// <summary>
/// Multiple status values can be provided with comma separated strings
/// </summary>
[Get("/pet/findByStatus")]
Task<ICollection<Pet>> FindPetsByStatus();
/// <summary>
/// Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
/// </summary>
[Get("/pet/findByTags")]
Task<ICollection<Pet>> FindPetsByTags();
/// <summary>
/// Returns a single pet
/// </summary>
[Get("/pet/{petId}")]
Task<Pet> GetPetById(long? petId);
[Post("/pet/{petId}")]
Task UpdatePetWithForm(long? petId);
[Delete("/pet/{petId}")]
Task DeletePet(long? petId);
[Post("/pet/{petId}/uploadImage")]
Task<ApiResponse> UploadFile(long? petId, [Body]StreamPart body);
/// <summary>
/// Returns a map of status codes to quantities
/// </summary>
[Get("/store/inventory")]
Task<IDictionary<string, int>> GetInventory();
/// <summary>
/// Place a new order in the store
/// </summary>
[Post("/store/order")]
Task<Order> PlaceOrder([Body]Order body);
/// <summary>
/// For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
/// </summary>
[Get("/store/order/{orderId}")]
Task<Order> GetOrderById(long? orderId);
/// <summary>
/// For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
/// </summary>
[Delete("/store/order/{orderId}")]
Task DeleteOrder(long? orderId);
/// <summary>
/// This can only be done by the logged in user.
/// </summary>
[Post("/user")]
Task CreateUser([Body]User body);
/// <summary>
/// Creates list of users with given input array
/// </summary>
[Post("/user/createWithList")]
Task<User> CreateUsersWithListInput([Body]ICollection<User> body);
[Get("/user/login")]
Task<string> LoginUser();
[Get("/user/logout")]
Task LogoutUser();
[Get("/user/{username}")]
Task<User> GetUserByName(string username);
/// <summary>
/// This can only be done by the logged in user.
/// </summary>
[Put("/user/{username}")]
Task UpdateUser(string username, [Body]User body);
/// <summary>
/// This can only be done by the logged in user.
/// </summary>
[Delete("/user/{username}")]
Task DeleteUser(string username);
}
}
Using the generated code
RestService
Here's an example usage of the generated code above
using Refit;
using System;
using System.Threading.Tasks;
namespace Your.Namespace.Of.Choice.GeneratedCode;
internal class Program
{
private static async Task Main(string[] args)
{
var client = RestService.For<ISwaggerPetstore>("https://petstore3.swagger.io/api/v3");
var pet = await client.GetPetById(2);
Console.WriteLine($"Name: {pet.Name}");
Console.WriteLine($"Category: {pet.Category.Name}");
Console.WriteLine($"Status: {pet.Status}");
}
}
The RestService
class generates an implementation of ISwaggerPetstore
that uses HttpClient
to make its calls.
The code above when run will output something like this:
Name: Gatitotototo
Category: Chaucito
Status: Sold
ASP.NET Core and HttpClientFactory
Here's an example Minimal API with the Refit.HttpClientFactory
library:
using Refit;
using Your.Namespace.Of.Choice.GeneratedCode;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
builder.Services
.AddRefitClient<ISwaggerPetstore>()
.ConfigureHttpClient(c => c.BaseAddress = new Uri("https://petstore3.swagger.io/api/v3"));
var app = builder.Build();
app.MapGet(
"/pet/{id:long}",
async (ISwaggerPetstore petstore, long id) =>
{
try
{
return Results.Ok(await petstore.GetPetById(id));
}
catch (Refit.ApiException e)
{
return Results.StatusCode((int)e.StatusCode);
}
})
.WithName("GetPetById")
.WithOpenApi();
app.UseHttpsRedirection();
app.UseSwaggerUI();
app.UseSwagger();
app.Run();
.NET Core supports registering the generated ISwaggerPetstore
interface via HttpClientFactory
The following request to the API above
$ curl -X 'GET' 'https://localhost:5001/pet/1' -H 'accept: application/json'
Returns a response that looks something like this:
{
"id": 1,
"name": "Special_char_owner_!@#$^&()`.testing",
"photoUrls": [
"https://petstore3.swagger.io/resources/photos/623389095.jpg"
],
"tags": [],
"status": "Sold"
}
System requirements
.NET 7.0
For tips and tricks on software development, check out my blog
If you find this useful and feel a bit generous then feel free to buy me a coffee ☕
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.
Version | Downloads | Last Updated |
---|---|---|
1.6.1 | 93,814 | 7/8/2025 |
1.6.1-preview.75 | 122 | 7/8/2025 |
1.6.0 | 104,659 | 6/17/2025 |
1.6.0-preview.74 | 342 | 6/10/2025 |
1.5.6 | 93,802 | 6/7/2025 |
1.5.6-preview.73 | 126 | 5/31/2025 |
1.5.5 | 343,320 | 5/4/2025 |
1.5.5-preview.70 | 57 | 5/30/2025 |
1.5.5-preview.69 | 156 | 4/30/2025 |
1.5.4 | 87,000 | 4/26/2025 |
1.5.3 | 343,933 | 3/30/2025 |
1.5.3-preview.68 | 295 | 3/23/2025 |
1.5.3-preview.67 | 601 | 1/30/2025 |
1.5.2 | 930,517 | 1/29/2025 |
1.5.1 | 61,032 | 1/25/2025 |
1.5.1-preview.66 | 82 | 1/25/2025 |
1.5.0 | 87,673 | 1/19/2025 |
1.5.0-preview.65 | 425 | 12/8/2024 |
1.5.0-preview.64 | 94 | 12/7/2024 |
1.5.0-preview.63 | 94 | 12/7/2024 |
1.4.1 | 930,622 | 11/20/2024 |
1.4.1-preview.62 | 187 | 11/4/2024 |
1.4.0 | 357,942 | 10/14/2024 |
1.4.0-preview.61 | 129 | 10/7/2024 |
1.3.2 | 328,316 | 9/23/2024 |
1.3.2-preview.60 | 84 | 9/23/2024 |
1.3.1 | 49,020 | 9/20/2024 |
1.3.0 | 96,862 | 9/14/2024 |
1.2.1-preview.59 | 81 | 9/13/2024 |
1.2.1-preview.58 | 101 | 9/11/2024 |
1.2.1-preview.57 | 84 | 9/11/2024 |
1.2.1-preview.56 | 94 | 9/9/2024 |
1.2.1-preview.55 | 3,256 | 9/2/2024 |
1.2.1-preview.54 | 4,740 | 8/29/2024 |
1.2.0 | 561,546 | 8/12/2024 |
1.2.0-preview.53 | 5,198 | 8/4/2024 |
1.2.0-preview.52 | 1,865 | 7/29/2024 |
1.1.3 | 359,883 | 7/19/2024 |
1.1.3-preview.51 | 79 | 7/19/2024 |
1.1.2 | 25,500 | 7/17/2024 |
1.1.2-preview.50 | 74 | 7/16/2024 |
1.1.2-preview.49 | 84 | 7/11/2024 |
1.1.1 | 188,806 | 7/6/2024 |
1.1.1-preview.48 | 95 | 7/4/2024 |
1.1.1-preview.47 | 93 | 7/1/2024 |
1.1.1-preview.46 | 92 | 6/28/2024 |
1.1.0.45-preview | 120 | 6/25/2024 |
1.0.2 | 238,601 | 6/13/2024 |
1.0.1 | 48,384 | 6/7/2024 |
1.0.0 | 245,927 | 5/3/2024 |
0.9.9.44-preview | 109 | 4/29/2024 |
0.9.9 | 8,142 | 3/7/2024 |
0.9.8 | 3,728 | 2/27/2024 |
0.9.7 | 72,029 | 2/7/2024 |
0.9.6 | 285 | 1/29/2024 |
0.9.5 | 41,769 | 1/15/2024 |
0.9.4.43-preview | 135 | 1/15/2024 |
0.9.4 | 32,126 | 1/12/2024 |
0.9.3.42-preview | 173 | 1/10/2024 |
0.9.2 | 20,143 | 1/10/2024 |
0.9.1 | 3,932 | 1/9/2024 |
0.9.0 | 3,131 | 1/9/2024 |
0.8.7.41-preview | 179 | 1/3/2024 |
0.8.7.40-preview | 152 | 12/20/2023 |
0.8.7 | 55,067 | 12/18/2023 |
0.8.6.39-preview | 168 | 12/14/2023 |
0.8.6.38-preview | 197 | 12/14/2023 |
0.8.6 | 3,582 | 12/11/2023 |
0.8.5 | 56,895 | 11/23/2023 |
0.8.4 | 421 | 11/7/2023 |
0.8.3 | 290 | 10/31/2023 |
0.8.2 | 466 | 10/9/2023 |
0.8.1 | 920 | 10/4/2023 |
0.8.0 | 1,785 | 9/23/2023 |
0.7.5 | 2,763 | 9/7/2023 |
0.7.4 | 384 | 9/6/2023 |
0.7.3.37-preview | 249 | 8/25/2023 |
0.7.3.36-preview | 279 | 8/25/2023 |
0.7.3.35-preview | 282 | 8/21/2023 |
0.7.3.34-preview | 284 | 8/15/2023 |
0.7.3.33-preview | 267 | 8/12/2023 |
0.7.3 | 2,063 | 8/26/2023 |
0.7.2.32-preview | 257 | 8/7/2023 |
0.7.2 | 3,896 | 8/7/2023 |
0.7.1.31-preview | 290 | 8/2/2023 |
0.7.1.30-preview | 223 | 8/2/2023 |
0.7.1.29-preview | 289 | 8/1/2023 |
0.7.1 | 738 | 8/3/2023 |
0.7.0.28-preview | 212 | 7/28/2023 |
0.7.0.27-preview | 315 | 7/28/2023 |
0.7.0.26-preview | 296 | 7/27/2023 |
0.7.0.23-preview | 282 | 7/27/2023 |
0.7.0.22-preview | 340 | 7/27/2023 |
0.7.0.21-preview | 270 | 7/27/2023 |
0.7.0.20-preview | 310 | 7/27/2023 |
0.7.0 | 470 | 7/31/2023 |
0.6.3 | 1,232 | 7/22/2023 |
0.6.2 | 13,795 | 6/22/2023 |
0.6.1 | 368 | 6/20/2023 |
0.6.0 | 755 | 6/15/2023 |
0.5.30 | 552 | 6/12/2023 |
0.5.29 | 187 | 6/12/2023 |
0.5.28 | 210 | 6/10/2023 |
0.5.27 | 264 | 5/24/2023 |
0.5.26 | 327 | 5/11/2023 |
0.5.25 | 254 | 5/10/2023 |
0.5.3 | 236 | 5/5/2023 |
0.5.2 | 199 | 5/2/2023 |
0.5.1 | 207 | 5/2/2023 |
0.5.0 | 258 | 4/28/2023 |
0.4.2 | 289 | 4/24/2023 |
0.4.1 | 483 | 4/3/2023 |
0.4.0 | 353 | 3/24/2023 |
0.3.17 | 12,459 | 3/24/2023 |
0.3.16 | 296 | 3/22/2023 |
0.3.4 | 261 | 3/22/2023 |
0.3.3 | 352 | 3/17/2023 |
0.3.2 | 326 | 3/16/2023 |
0.3.1 | 298 | 3/14/2023 |
0.3.0 | 297 | 3/14/2023 |
0.2.4-alpha | 313 | 3/1/2023 |
0.2.3-alpha | 222 | 2/27/2023 |
0.2.2-alpha | 262 | 2/25/2023 |
0.2.1-alpha | 289 | 2/25/2023 |
0.2.0-alpha | 243 | 2/24/2023 |
0.1.5-alpha | 293 | 2/18/2023 |
0.1.4-alpha | 332 | 2/17/2023 |
0.1.3-alpha | 322 | 2/17/2023 |
0.1.2-alpha | 289 | 2/17/2023 |