Refit | 适用于 .NET Core、Xamarin 和 .NET 的自动类型安全 REST 库-51CTO.COM

前言

Refit是一个用于创建基于REST API的C#接口的库。它允许开发人员使用简单的接口定义来描述API终结点，并自动生成HTTP请求。Refit还提供了一些方便的功能，如参数化URLs、自定义请求头和处理错误等。

入门

Refit 是一个用于简化 HTTP 请求的库，它可以轻松地将接口定义转换为可以进行网络请求的具体实现。下面是在 .NET 中使用 Refit 的入门示例：

安装 Refit：

在 Visual Studio 中，打开你的项目。
进入 “工具” -> “NuGet 包管理器” -> “程序包管理器控制台”。
在控制台中运行以下命令来安装 Refit。

Install-Package Refit

创建 API 接口：

在你的项目中创建一个新的 C# 接口文件。
在接口中定义你的 API 请求方法。例如，以下代码定义了一个获取用户信息的 GET 请求。

public interface IUserApi
{
    [Get("/users/{id}")]
    Task<User> GetUserAsync(int id);
}

实例化 Refit 接口：

在需要使用 API 的地方，实例化 RestService.For<T>() 来创建接口的具体实现。如下所示：

var userApi = RestService.For<IUserApi>("https://api.example.com");

发起 API 请求：

使用创建的接口实例调用定义的方法，即可发起相应的 HTTP 请求并获取响应。以下是一个使用前面定义的 GetUserAsync 方法的示例

var user = await userApi.GetUserAsync(1);

以上就是使用 Refit 进行简单的 API 请求的基本步骤。可以根据自己的需求在接口中定义更多的方法，并使用 Refit 的注解来配置请求的 URL、HTTP 方法和其他参数。

示例

下面是一个完整的使用 Refit 的示例，演示了如何使用 Refit 发起 HTTP 请求并处理响应：

首先，在你的项目中添加 Refit 包引用。可以通过 NuGet 包管理器或者 .NET CLI 完成。

创建 API 接口文件：

using System.Collections.Generic;
using System.Threading.Tasks;
using Refit;

public interface IApiService
{
    [Get("/posts")]
    Task<List<Post>> GetPosts();

    [Get("/posts/{id}")]
    Task<Post> GetPost(int id);

    [Post("/posts")]
    Task<Post> CreatePost([Body] Post post);

    [Put("/posts/{id}")]
    Task<Post> UpdatePost(int id, [Body] Post post);

    [Delete("/posts/{id}")]
    Task DeletePost(int id);
}

public class Post
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Body { get; set; }
    public int UserId { get; set; }
}

实例化 Refit 接口：

var apiService = RestService.For<IApiService>("https://jsonplaceholder.typicode.com");

发起 API 请求：

// 获取所有帖子
var posts = await apiService.GetPosts();
foreach (var post in posts)
{
    Console.WriteLine($"ID: {post.Id}, Title: {post.Title}");
}

// 获取单个帖子
var postId = 1;
var post = await apiService.GetPost(postId);
Console.WriteLine($"Post ID: {post.Id}, Title: {post.Title}, Body: {post.Body}");

// 创建新帖子
var newPost = new Post
{
    Title = "New Post",
    Body = "This is a new post",
    UserId = 1
};
var createdPost = await apiService.CreatePost(newPost);
Console.WriteLine($"Created Post ID: {createdPost.Id}, Title: {createdPost.Title}");

// 更新帖子
var updatedPost = new Post
{
    Id = postId,
    Title = "Updated Post",
    Body = "This post has been updated",
    UserId = 1
};
var updatedPost = await apiService.UpdatePost(postId, updatedPost);
Console.WriteLine($"Updated Post ID: {updatedPost.Id}, Title: {updatedPost.Title}, Body: {updatedPost.Body}");

// 删除帖子
await apiService.DeletePost(postId);

上述示例演示了如何使用 Refit 发起 GET、POST、PUT 和 DELETE 请求，并处理响应。你可以根据实际需求定义和使用其他 API 方法。

此外，Refit 还提供了许多其他功能，如请求拦截器、错误处理和文件上传等。你可以查阅 Refit 的官方文档以了解更多详细信息和示例代码。