《Web API 的设计与开发》读书笔记

设计优美的Web API:

易于使用、便于更改、健壮性好、不怕公开

REST的两层含义:

  • 指符合Fielding的REST架构风格的Web服务系统
  • 指使用符合RPC风格的XML或JSON + HTTP接口的系统(不使用SOAP)

端点的基本设计:

  • 短小便于输入的URI-
  • 人可以读懂的URI
  • 没有大小写混用的URI
  • 修改方便的URI
  • 不暴露服务端架构的URI
  • 规则统一的URI

HTTP方法和端点:

  • GET获取资源
  • POST新增资源
  • PUT更新已有资源
  • DELETE删除资源
  • PATCH更新部分资源

查询参数和路径的使用区别

  • 表示唯一资源时,放在路径中
  • 当参数可以忽略时,放在查询参数中

RESTful的设计级别

  • 使用HTTP
  • 引入资源的概念
  • 引入HTTP动词
  • 引入HATEOAS

如何指定数据格式?

  • 查询参数:url?format=xml
  • 扩展名:/url.json
  • Accept头部字段

让用户决定响应的内容

  • GraphQL

通过状态码表示错误信息

1xx:消息
2xx:成功
3xx:重定向
4xx:客户端原因造成的错误
5xx:服务端原因造成的错误

缓存与HTTP协议规范

RFC7234:过期模型/验证模型
过期模型:Cache-Control/Expires
验证模型:Last-Modified/ETag
Vary首部:指定缓存单位
Conent-Type/Accept:指定媒体类型

API版本控制

  • 在URI中嵌入版本号
  • 在查询字符串中加入版本信息
  • 通过媒体类型指定版本

API安全问题

  • 推荐使用HTTPS
  • XSS/XSRF注入漏洞
  • 返回正确的数据格式
  • 使用安全相关首部
  • 采用KVS实现访问限制

提供API文档

  • API Blueprint
  • API Console/Apigee
  • 提供SDK
雪轻鸿 CSDN认证博客专家 .NET Python 伪·全栈攻城狮
谢谢你,在这世界的角落,找到我,一个即将进入而立之年的中年大叔,常年以 飞鸿踏雪 的花名混迹江湖。在现实生活中,我是一名 伪·全栈攻城狮,因为我觉得,什么都略懂一点,生活会更多彩一些。目前,主要关注.NET、.NET Core、Python、数据分析、微服务、Web 等技术方向。日常行为:读书、写作、电影、烹饪、洞箫等。喜欢看日剧/纪录片/科普、刷B站、刷LeetCode等。
已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 成长之路 设计师:Amelia_0503 返回首页
实付 9.90元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值