RESTful API 学习笔记

本文发布于 6 年前，部分内容可能已经失去参考价值。

在学习和使用 ASP.NET Web API 之前，最好先对 RESTful 有所了解。它是一种软件架构风格、设计风格，而不是标准。

推荐视频教程：https://www.imooc.com/learn/811

讲师：会飞的鱼Xia

需时：2小时25分

REST API 测试工具：

在 Chrome 网上应用店中搜索：Restlet Client

或网站 https://client.restlet.com

>>> 资源路径

SCHEME :// HOST [ ":" PORT ] [ PATH [ "?" QUERY ]]

其中 PATH 中的资源名称应该使用复数名词，举例：

GET https://xoyozo.net/api/Articles/{id}

POST https://xoyozo.net/api/Articles

>>> HTTP verb（对应 CURD 操作）：

方法	功能	ASP.NET Web API 接口返回类型（一般的）
GET	取一个或多个资源	T 或 IEnumerable<T>
POST	增加一个资源	T
PUT	修改一个资源	T
DELETE	删除一个资源	void
PATCH	更新一个资源（资源的部分属性）
HEAD	获取报头
OPTIONS	查询服务器性能或资源相关选项和需求

>>> 过滤信息：

如分页、搜索等

>>> 常用状态码：

200	OK	指示请求已成功
201	Created	资源创建成功（常见用例是一个 PUT 请求的结果）
202	Accepted	该请求已被接收但尚未起作用。它是非承诺的，这意味着HTTP中没有办法稍后发送指示处理请求结果的异步响应。
204	No Content	成功 PUT（修改）或 DELETE（删除）一个资源后返回空内容（ASP.NET Web API 中将接口返回类型设置为 void 即可）
400	Bad Request	服务器无法理解请求（如必填项未填、内容超长、分页大小超限等），幂等
401	Unauthorized	未授权（如用户未登录时执行了须要登录才能执行的操作），通俗地讲，是服务器告诉你，“你没有通过身份验证 - 根本没有进行身份验证或验证不正确 - 但请重新进行身份验证并再试一次。”这是暂时的，服务器要求你在获得授权后再试一次。
403	Forbidden	服务器理解请求但拒绝授权（是永久禁止的并且与应用程序逻辑相关联（如不正确的密码、尝试删除其它用户发表的文章）、IP 被禁止等），通俗地讲，是服务器告诉你，“我很抱歉。我知道你是谁 - 我相信你说你是谁 - 但你只是没有权限访问此资源。”
404	Not Found	找不到请求的资源（指资源不存在，如果找到但无权访问则应返回 403）
405	Method Not Allowed	请求方法被禁用（HTTP 动词）
500	Internal Server Error	服务器遇到阻止它履行请求的意外情况（如数据库连接失败）
503	Service Unavailable	服务器尚未准备好处理请求（常见原因是服务器因维护或重载而停机，这是临时的，可用于在单线程处理事务时遇到被锁定时的响应，如抽奖活动、抢楼活动，防止因并发导致逻辑错误）