自动类型安全的REST .NET标准库refit
在SCOTT HANSELMAN 博客上看到一个好东西《Exploring refit, an automatic type-safe REST library for .NET Standard》,他推荐了一个.NET标准1.4 的自动类型安全的REST库refit。 refit 类似于Java的Retrofit,是一套RESTful架构的.NET客户端实现,基于特性,提供把REST API返回的数据转化为(Plain Ordinary C# Object,简单C#对象),POCO to JSON,网络请求(POST,GET,PUT,DELETE等)封装,内部封装使用HttpClient,前者专注于接口的封装,后者专注于网络请求的高效,二者分工协作。我们的应用程序通过 refit
请求网络,实际上是使用 refit
接口层封装请求参数、Header、Url 等信息,之后由 HttpClient
完成后续的请求操作,在服务端返回数据之后,HttpClient
将原始的结果交给 refit
,后者根据用户的需求对结果进行解析的过程。
例如:
public interface IGitHubApi
{[Get("/users/{user}")]Task<User> GetUser(string user);
}
定义上面的一个REST API接口。 该接口定义了一个函数 GetUser,该函数会通过HTTP GET请求去访问服务器的/users/{user}
路径并把返回的结果封装为User POCO 对象返回。
其中URL路径中的{user}
的值为GetUser函数中的参数 user
的取值。
然后通过 RestService
类来生成一个 IGitHubApi
接口的实现,使用HttpClient 调用;
var gitHubApi = RestService.For<IGitHubApi>(https://api.github.com);
var octocat = await gitHubApi.GetUser("octocat");
从上面的示例可以看出, refit使用特性来声明HTTP请求
支持 URL 参数替换和查询参数
返回结果转换为C#对象(返回结果可以为JSON)
支持 Multipart请求和文件上传
具体使用文档
函数和函数参数上的特性声明了请求方式
1、请求方式
每个函数都必须带有 HTTP特性来表明请求方式和请求的URL路径。类库中有5个HTTP注解:GET, POST, PUT,DELETE和HEAD。注解中的参数为请求的相对URL路径。
[Get("/users/list")]
在URL路径中也可以指定URL参数:
[Get("/users/list?sort=desc")]
2、URL处理
请求的URL可以根据函数参数动态更新。一个可替换的区块为用 {
和 }
包围的字符串,而函数参数必需用 @
AliasAs特性
标明,并且特性的参数为 同样的字符串
[Get("/group/{id}/users")]//注意 字符串id
Task<List<User>> GroupList([AliasAs("id")] int groupId); //注意 AliasAs特性的参数要和前面的字符串一样 id
还支持查询参数
[Get("/group/{id}/users")]
Task<List<User>> GroupList([AliasAs("id")] int groupId, [AliasAs("sort")] string sortOrder);GroupList(4, "desc");
>>> "/group/4/users?sort=desc"
3、请求体(Request Body)
通过[Body]特性
可以声明一个对象作为请求体发送到服务器。
[Post("/users/new")]
Task CreateUser([Body] User user);
对象将被RestService
使用对应的转换器转换为字符串或者字节流提交到服务器。
4、FORM ENCODED AND MULTIPART 表单和Multipart
函数也可以注解为发送表单数据和multipart 数据
5、服务器结果转换为C# 对象
使用RestService
的转换器把HTTP请求结果(默认为JSON)转换为C#对象,C#对象通过函数返回值指定
6、添加请求头
我们可以通过[Headers]来添加请求头,支持动态的请求头。
refit
是非常强大的,本文通过丰富的示例和对源码的挖掘,向大家展示了 refit自身强大的功能以及扩展性
原文:http://www.cnblogs.com/shanyou/p/8047749.html
.NET社区新闻,深度好文,欢迎访问公众号文章汇总 http://www.csharpkit.com
自动类型安全的REST .NET标准库refit相关推荐
- 自动类型安全的.NET标准REST库refit
在SCOTT HANSELMAN 博客上看到一个好东西<Exploring refit, an automatic type-safe REST library for .NET Standar ...
- python缺少标准库_Python 实现自动导入缺失的库
作者:豌豆花下猫 在写 Python 项目的时候,我们可能经常会遇到导入模块失败的错误:ImportError: No module named 'xxx'或者ModuleNotFoundError: ...
- python缺少标准库_干货分享:Python如何自动导入缺失的库
很多同学在写Python项目时会遇到导入模块失败的情况:ImportError: No module named 'xxx'或者ModuleNotFoundError: No module named ...
- 基于keil5自动配置stm32f103标准库的官网freertos移植
基于keil5自动配置stm32f103标准库的官网freertos移植 前言 序言:利用keil5自动配置stm32f103标准库工程 闲话 正式篇 移植官网FreeRTOS 前言 当笔者学习s ...
- GCC 连接器、链接标准库 gcc -l、链接手动创建库(指定目录的库 gcc -L)
1. 链接器 链接器把多个二进制的目标文件(object file)链接成一个单独的可执行文件. 在链接过程中,它必须把符号(变量名.函数名等一些列标识符)用对应的数据的内存地址(变量地址.函数地址等 ...
- Python 标准库之 subprocesss
Python 目前已经废弃了 os.system.os.spawn*.os.popen*.popen2.*.commands.* 来执行其他语言的命令,取而代之的是 subprocess 模块. 运行 ...
- c++标准库 及 命名空间std
1.命名空间std C++标准中引入命名空间的概念,是为了解决不同模块或者函数库中相同标识符冲突的问题.有了命名空间的概念,标识符就被限制在特定的范围(函数)内,不会引起命名冲突.最典型的例子就是st ...
- C++标准库简介(转)
C++标准库的所有头文件都没有扩展名.C++标准库的内容总共在50个标准头文件中定义,其中18个提供了C库的功能. <cname>形式的标准头文件[ <complex>例外]其 ...
- pythonurllib标准_Python标准库urllib2的一些使用细节总结
Python 标准库中有很多实用的工具类,但是在具体使用时,标准库文档上对使用细节描述的并不清楚,比如 urllib2 这个 HTTP 客户端库.这里总结了一些 urllib2 的使用细节. 1.Pr ...
最新文章
- private的误解
- 宝石世界1.0游戏发布
- mysql中间件研究(Atlas,cobar,TDDL)
- TroubleShoot
- 腾讯重磅发布全栈机器学习平台Angel 3.0
- Centos6.5下升级Python版本
- 个人作业2——英语学习APP的案例分析
- 堆排序,为什么升序排列要建大堆,降序排列要建小堆
- mysql 5.6 登录 警告_解决mysql登录出现警告问题的简单方法
- Windows环境下通过lynx查看隐藏链接识别黑链方法
- Python零基础学习系列之三--Python编辑器选择
- 《算法分析》——布线问题
- 【电脑删不掉文件或文件夹】总结7种方法永久删除!
- 需要一个红警2的易语言源码
- C++版本OpenCv教程(十一)多通道分离与合并
- 【BZOJ 4242】水壶
- android obb在哪,.obb是什么文件?obb文件怎么用/放在哪里
- Windows操作系统的日志分析
- 2017计算机研究生专业排名,2017年USNews美国大学计算机硕士研究生专业排名TOP110...
- ps打不开图片显示计算机丢失,电脑的ps软件打不开图片怎么解决
热门文章
- 从社会数据到社会智慧的社会计算:新技术、新哲学、新文科
- Android项目--坦克大战
- oracle宽字节注入,CTF-sql-宽字节注入
- 2022 年,我身上发生的几件大事
- 两台电脑其中一台无法ping通的问题
- zigbee配置及常见错误总结---(Segment BANKED_CODE must be defined in a segment definition option)
- Unity教程||Unity添加中文字体||Unity知识记录--制作UI粒子特效
- 【iOS】—— 分类、扩展和关联对象
- 用Matlab求解方程
- 结对编程项目-四则运算(第一周阶段性总结)