refit

![Refit](https://raw.githubusercontent.com/reactiveui/refit/main/images/refit-logo.svg)

# Refit

[![Build](https://github.com/reactiveui/refit/actions/workflows/ci-build.yml/badge.svg)](https://github.com/reactiveui/refit/actions/workflows/ci-build.yml)
[![NuGet](https://img.shields.io/nuget/v/Refit.svg)](https://www.nuget.org/packages/Refit/)

Refit turns a C# interface into an HTTP client. Attributes describe the request method,
URL, headers and body. The source generator builds its implementation when your app compiles.
Your app keeps control of `HttpClient`, cancellation and serialization.

Start with the [Refit documentation](https://reactiveui.net/documentation/refit/).
It explains the concepts, walks through a first request, and links each topic to runnable
[source examples](https://github.com/reactiveui/refit/tree/main/src/examples/Documentation).
Examples use .NET 10 and C# 14 unless they state another target.
Website code blocks can show a subset of a complete example and omit its test setup.

## Packages

| Package | Purpose |
| --- | --- |
| [Refit](https://www.nuget.org/packages/Refit/) | Generated HTTP clients, request attributes, serializers and response types. Includes the generator, interface analyzers and code fixes. |
| [Refit.HttpClientFactory](https://www.nuget.org/packages/Refit.HttpClientFactory/) | Register clients with dependency injection and `IHttpClientFactory`, including generated-only and keyed registrations. |
| [Refit.Testing](https://www.nuget.org/packages/Refit.Testing/) | Match outgoing requests, supply local replies, verify calls and simulate network faults. Release streamed replies chunk by chunk, choose how request bodies are captured, and control simulated time. |
| [Refit.Newtonsoft.Json](https://www.nuget.org/packages/Refit.Newtonsoft.Json/) | Serialize content with Newtonsoft.Json. |
| [Refit.Xml](https://www.nuget.org/packages/Refit.Xml/) | Serialize XML content. |
| [Refit.Reflection](https://www.nuget.org/packages/Refit.Reflection/) | Optional request building through runtime reflection. Use generated clients for trimmed and Native AOT apps. |

System.Text.Json with generated metadata is the preferred JSON setup.
See [JSON configuration](https://www.reactiveui.net/documentation/refit/serialization/json/)
and [AOT guidance](https://www.reactiveui.net/documentation/refit/aot/).

## What you can build

| Surface | Documentation |
| --- | --- |
| HTTP methods, route placeholders and request inspection | [Routes](https://www.reactiveui.net/documentation/refit/requests/routes/) |
| Scalar, object and collection queries; formatting and converters | [Queries](https://www.reactiveui.net/documentation/refit/requests/queries/) |
| Static and dynamic headers, authorization and request state | [Headers](https://www.reactiveui.net/documentation/refit/requests/headers/) and [request context](https://www.reactiveui.net/documentation/refit/requests/request-context/) |
| Serialized bodies, forms, buffering and request