RestSharp基本使用方法

  • 关于RestSharp

RestSharp is a library that allows you to make REST and HTTP calls in .NET applications. It supports serialization, parameters, async functions, and more.

RestSharpC#的一个WepApi库,支持通用的Web接口处理,支持序列化、参数化、异步回调等。

  • 入门示例,带授权的GET请求
C# 复制代码
// 设置授权信息Authenticator,客户端级别,适用于多个请求共用
// 指定主页(基)地址
var opt = new RestClientOptions(HomeUrl)
{
    Authenticator = new HttpBasicAuthenticator("用户名", "密码")
};
var client = new RestClient(opt);

// 创建请求,指定相对地址
var req = new RestRequest("ui/api/f1?recordNum=0");
// 也可以在请求上单独设置授权信息,单个请求的级别
// req.Authenticator = Authenticator;

// 在client上执行异步的GET请求
var ans = await client.GetAsync(req);
ShowRest(req, ans);

// 显示应答方法
void ShowRest(RestRequest req, RestResponse ans)
{
    if(ans.IsSuccessful)
    {
        Log("请求成功:\r\n链接:" + ans.ResponseUri.AbsoluteUri + "\r\n结果:" + ans.Content);
    }
    else
    {
        Log("请求失败:\r\n链接:" + (ans.ResponseUri?.AbsoluteUri ?? req.Resource) + "\r\n原因:" + ans.Content);
    }
}
  • 一般流程,示例GET
C# 复制代码
// 1.创建client,指定基地址
var client = new RestClient('htpp://192.168.1.1:8089');
// 支持添加client级别的参数,如下:
// AddDefaultHeader
// AddDefaultHeaders
// AddDefaultParameter
// AddDefaultParameter
// AddDefaultParameter
// AddDefaultQueryParameter
// AddDefaultUrlSegment

// 2.创建请求,指定相对地址
var req = new RestRequest("/api/v1/ui/auth/f2");
// 设置参数
foreach(var p in Parameters)
{
    req.AddParameter(p.Key, p.Value);
}
// 参数还可以通过其他方式添加,如:
// req.AddBody("", ContentType.Json);
// req.AddObject(para)
// req.AddJsonBody(json_para);

// 3.添加授权信息(该步骤可选,看接口是否需要授权)
req.Authenticator = Authenticator;

// 其他参数设置,如:
// 添加Cookies AddCookie
// 添加Header  AddHeader
// 添加上传文件 AddFile

// 4.执行请求
// 请求方式支持:Get Post Put Delete Head Options Patch Merge Copy Search
var ans = client.Execute(req, Method.Get);
ShowRest(req, ans);
  • POST + JSON 示例
C# 复制代码
// 1.创建client,指定基地址
var client = new RestClient(HomeUrl);

// 2.创建请求,指定相对地址
var req = new RestRequest("api/v1/f3");
// 设置参数
// {"path":"2024/202411121649.zip","name":"my_baby","type":"file"}
req.AddJsonBody(Para);

// 3.添加授权信息(该步骤可选,看接口是否需要授权)
req.Authenticator = Authenticator;

// 添加其他信息,指定使用JSON内容
req.AddHeader("X-Requested-With", "XMLHttpRequest");
req.AddHeader("Content-Type", "application/json");

// 4.执行请求
var ans = client.Execute(req, Method.Post);
ShowRest(req, ans);
  • PUT 上传文件
C# 复制代码
// 1.创建client,指定基地址
var client = new RestClient(HomeUrl);

// 2.创建请求,指定相对地址
var filePath = Parameters["FilePath"];
var repoPath = Parameters["RepoPath"];
var req = new RestRequest("/artifactory/" + ReposName + "/" + repoPath);

// 设置上传的目标文件
req.AddFile(Path.GetFileName(filePath), filePath);

// 3.添加授权信息(该步骤可选,看接口是否需要授权)
req.Authenticator = Authenticator;

// 4.执行请求
var ans = client.Execute(req, Method.Put);
ShowRest(req, ans);
相关推荐
Lin_Aries_042116 分钟前
容器化简单的 Java 应用程序
java·linux·运维·开发语言·docker·容器·rpc
techdashen1 小时前
12分钟讲解Python核心理念
开发语言·python
山海不说话1 小时前
Java后端面经(八股——Redis)
java·开发语言·redis
郝学胜-神的一滴1 小时前
谨慎地迭代函数所收到的参数 (Effective Python 第31条)
开发语言·python·程序人生·软件工程
大虾别跑2 小时前
vc无法启动
java·开发语言
郭老二2 小时前
【JAVA】从入门到放弃-01-HelloWorld
java·开发语言
北城以北88882 小时前
JavaScript--基础ES(一)
开发语言·javascript·intellij-idea
say_fall2 小时前
C语言底层学习(2.指针与数组的关系与应用)(超详细)
c语言·开发语言·学习
eqwaak02 小时前
Python Pillow库详解:图像处理的瑞士军刀
开发语言·图像处理·python·语言模型·pillow
柯南二号2 小时前
【Java后端】《Spring Boot Starter 原理详解》博客
java·开发语言·spring boot