Refitter 0.1.4-alpha
This is a prerelease version of Refitter.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet tool install --global Refitter --version 0.1.4-alpha
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local Refitter --version 0.1.4-alpha
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Refitter&version=0.1.4-alpha&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Refitter --version 0.1.4-alpha
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Refitter
Refitter is a CLI tool for generating a C# REST API Client using the Refit library.
Usage:
To generate code from an OpenAPI specifications file, run the following:
$ refitter [path to OpenAPI spec file]
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 GeneratedCode
{
public interface ISwaggerPetstore
{
[Put("/pet")]
Task<Pet> UpdatePet([Body]Pet body);
[Post("/pet")]
Task<Pet> AddPet([Body]Pet body);
[Get("/pet/findByStatus")]
Task<ICollection<Pet>> FindPetsByStatus();
[Get("/pet/findByTags")]
Task<ICollection<Pet>> FindPetsByTags();
[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]FileParameter body);
[Get("/store/inventory")]
Task<IDictionary<string, int>> GetInventory();
[Post("/store/order")]
Task<Order> PlaceOrder([Body]Order body);
[Get("/store/order/{orderId}")]
Task<Order> GetOrderById(long? orderId);
[Delete("/store/order/{orderId}")]
Task DeleteOrder(long? orderId);
[Post("/user")]
Task CreateUser([Body]User body);
[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);
[Put("/user/{username}")]
Task UpdateUser(string username, [Body]User body);
[Delete("/user/{username}")]
Task DeleteUser(string username);
}
}
The RestService
class generates an implementation of ISwaggerPetstore
that uses HttpClient
to make its calls.
Here's an example usage of the generated code above
using Refit;
using System;
using System.Threading.Tasks;
namespace 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 code above when run will output something like this:
Name: Gatitotototo
Category: Chaucito
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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
Version | Downloads | Last Updated |
---|---|---|
1.6.2 | 23,415 | 8/18/2025 |
1.6.2-preview.76 | 153 | 8/13/2025 |
1.6.1 | 215,184 | 7/8/2025 |
1.6.1-preview.75 | 131 | 7/8/2025 |
1.6.0 | 104,766 | 6/17/2025 |
1.6.0-preview.74 | 349 | 6/10/2025 |
1.5.6 | 93,884 | 6/7/2025 |
1.5.6-preview.73 | 130 | 5/31/2025 |
1.5.5 | 343,627 | 5/4/2025 |
1.5.5-preview.70 | 62 | 5/30/2025 |
1.5.5-preview.69 | 161 | 4/30/2025 |
1.5.4 | 87,723 | 4/26/2025 |
1.5.3 | 344,338 | 3/30/2025 |
1.5.3-preview.68 | 301 | 3/23/2025 |
1.5.3-preview.67 | 606 | 1/30/2025 |
1.5.2 | 931,345 | 1/29/2025 |
1.5.1 | 61,066 | 1/25/2025 |
1.5.1-preview.66 | 86 | 1/25/2025 |
1.5.0 | 87,683 | 1/19/2025 |
1.5.0-preview.65 | 429 | 12/8/2024 |
1.5.0-preview.64 | 100 | 12/7/2024 |
1.5.0-preview.63 | 98 | 12/7/2024 |
1.4.1 | 930,809 | 11/20/2024 |
1.4.1-preview.62 | 193 | 11/4/2024 |
1.4.0 | 358,023 | 10/14/2024 |
1.4.0-preview.61 | 133 | 10/7/2024 |
1.3.2 | 328,369 | 9/23/2024 |
1.3.2-preview.60 | 89 | 9/23/2024 |
1.3.1 | 49,027 | 9/20/2024 |
1.3.0 | 96,870 | 9/14/2024 |
1.2.1-preview.59 | 86 | 9/13/2024 |
1.2.1-preview.58 | 105 | 9/11/2024 |
1.2.1-preview.57 | 88 | 9/11/2024 |
1.2.1-preview.56 | 102 | 9/9/2024 |
1.2.1-preview.55 | 3,263 | 9/2/2024 |
1.2.1-preview.54 | 4,747 | 8/29/2024 |
1.2.0 | 561,608 | 8/12/2024 |
1.2.0-preview.53 | 5,208 | 8/4/2024 |
1.2.0-preview.52 | 1,871 | 7/29/2024 |
1.1.3 | 359,891 | 7/19/2024 |
1.1.3-preview.51 | 84 | 7/19/2024 |
1.1.2 | 25,508 | 7/17/2024 |
1.1.2-preview.50 | 78 | 7/16/2024 |
1.1.2-preview.49 | 94 | 7/11/2024 |
1.1.1 | 188,814 | 7/6/2024 |
1.1.1-preview.48 | 99 | 7/4/2024 |
1.1.1-preview.47 | 97 | 7/1/2024 |
1.1.1-preview.46 | 97 | 6/28/2024 |
1.1.0.45-preview | 124 | 6/25/2024 |
1.0.2 | 238,609 | 6/13/2024 |
1.0.1 | 48,392 | 6/7/2024 |
1.0.0 | 246,005 | 5/3/2024 |
0.9.9.44-preview | 113 | 4/29/2024 |
0.9.9 | 8,152 | 3/7/2024 |
0.9.8 | 3,733 | 2/27/2024 |
0.9.7 | 72,034 | 2/7/2024 |
0.9.6 | 291 | 1/29/2024 |
0.9.5 | 41,783 | 1/15/2024 |
0.9.4.43-preview | 138 | 1/15/2024 |
0.9.4 | 32,133 | 1/12/2024 |
0.9.3.42-preview | 179 | 1/10/2024 |
0.9.2 | 20,150 | 1/10/2024 |
0.9.1 | 3,938 | 1/9/2024 |
0.9.0 | 3,138 | 1/9/2024 |
0.8.7.41-preview | 182 | 1/3/2024 |
0.8.7.40-preview | 157 | 12/20/2023 |
0.8.7 | 55,074 | 12/18/2023 |
0.8.6.39-preview | 172 | 12/14/2023 |
0.8.6.38-preview | 201 | 12/14/2023 |
0.8.6 | 3,590 | 12/11/2023 |
0.8.5 | 56,967 | 11/23/2023 |
0.8.4 | 425 | 11/7/2023 |
0.8.3 | 295 | 10/31/2023 |
0.8.2 | 473 | 10/9/2023 |
0.8.1 | 928 | 10/4/2023 |
0.8.0 | 1,790 | 9/23/2023 |
0.7.5 | 2,775 | 9/7/2023 |
0.7.4 | 394 | 9/6/2023 |
0.7.3.37-preview | 259 | 8/25/2023 |
0.7.3.36-preview | 291 | 8/25/2023 |
0.7.3.35-preview | 292 | 8/21/2023 |
0.7.3.34-preview | 295 | 8/15/2023 |
0.7.3.33-preview | 277 | 8/12/2023 |
0.7.3 | 2,076 | 8/26/2023 |
0.7.2.32-preview | 269 | 8/7/2023 |
0.7.2 | 3,909 | 8/7/2023 |
0.7.1.31-preview | 300 | 8/2/2023 |
0.7.1.30-preview | 235 | 8/2/2023 |
0.7.1.29-preview | 299 | 8/1/2023 |
0.7.1 | 748 | 8/3/2023 |
0.7.0.28-preview | 223 | 7/28/2023 |
0.7.0.27-preview | 327 | 7/28/2023 |
0.7.0.26-preview | 308 | 7/27/2023 |
0.7.0.23-preview | 292 | 7/27/2023 |
0.7.0.22-preview | 351 | 7/27/2023 |
0.7.0.21-preview | 282 | 7/27/2023 |
0.7.0.20-preview | 323 | 7/27/2023 |
0.7.0 | 482 | 7/31/2023 |
0.6.3 | 1,244 | 7/22/2023 |
0.6.2 | 14,222 | 6/22/2023 |
0.6.1 | 381 | 6/20/2023 |
0.6.0 | 769 | 6/15/2023 |
0.5.30 | 566 | 6/12/2023 |
0.5.29 | 202 | 6/12/2023 |
0.5.28 | 223 | 6/10/2023 |
0.5.27 | 278 | 5/24/2023 |
0.5.26 | 343 | 5/11/2023 |
0.5.25 | 267 | 5/10/2023 |
0.5.3 | 248 | 5/5/2023 |
0.5.2 | 214 | 5/2/2023 |
0.5.1 | 223 | 5/2/2023 |
0.5.0 | 273 | 4/28/2023 |
0.4.2 | 304 | 4/24/2023 |
0.4.1 | 495 | 4/3/2023 |
0.4.0 | 366 | 3/24/2023 |
0.3.17 | 12,604 | 3/24/2023 |
0.3.16 | 309 | 3/22/2023 |
0.3.4 | 274 | 3/22/2023 |
0.3.3 | 365 | 3/17/2023 |
0.3.2 | 338 | 3/16/2023 |
0.3.1 | 312 | 3/14/2023 |
0.3.0 | 312 | 3/14/2023 |
0.2.4-alpha | 325 | 3/1/2023 |
0.2.3-alpha | 236 | 2/27/2023 |
0.2.2-alpha | 278 | 2/25/2023 |
0.2.1-alpha | 304 | 2/25/2023 |
0.2.0-alpha | 256 | 2/24/2023 |
0.1.5-alpha | 306 | 2/18/2023 |
0.1.4-alpha | 346 | 2/17/2023 |
0.1.3-alpha | 335 | 2/17/2023 |
0.1.2-alpha | 301 | 2/17/2023 |