SharePoint REST 服务

3 分钟

SharePoint 包括表述性状态转移 (REST) 服务，该服务相当于现有的 SharePoint 客户端对象模型。现在，开发人员可以通过使用支持 REST Web 请求的任何技术与 SharePoint 数据进行远程交互。基本上，开发人员可以通过使用 REST Web 技术和标准 Open Data Protocol (OData) 语法，从其 SharePoint 加载项、解决方案和客户端应用程序执行创建、读取、更新和删除 (CRUD) 操作。

SharePoint REST 服务工作原理

SharePoint 使您能够通过 REST 与 SharePoint 站点进行远程交互。现在，您可以使用支持标准 REST 功能的任何技术直接与 SharePoint 对象交互。

要通过使用 REST 访问 SharePoint 资源，可以使用与所需客户端对象模型 API 对应的 OData 标准来构造 RESTful HTTP 请求，如以下示例中所示：

GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

将 HTTP 命令与 SharePoint REST 服务结合使用

要使用内置到 SharePoint 的 REST 功能，可以使用与要使用的客户端对象模型 API 对应的 OData 标准来构造 RESTful HTTP 请求。 Client.svc Web 服务处理 HTTP 请求并以 Atom 或 JSON 格式提供相应响应。然后，客户端应用程序必须解析该响应。

SharePoint REST 服务中的终结点对应 SharePoint 客户端对象模型中的类型和成员。通过使用 HTTP 请求，可以使用这些 REST 终结点对 SharePoint 实体（如列表和站点）执行典型 CRUD 操作。

下表概述了 HTTP 请求。

操作	HTTP 请求	要点
读取资源	GET	可能需要修改返回的数据格式。
创建或更新资源	POST	使用 POST 可创建实体，如列表和站点。 SharePoint REST 服务支持将包含对象定义的 POST 命令发送到表示集合的终结点。对于 POST 操作，非必需的属性会设置为其默认值。如果尝试在 POST 操作中设置只读属性，则服务会返回异常。
更新或插入资源	PUT	使用 PUT 和 MERGE 操作可更新现有 SharePoint 对象。表示对象属性集操作的任何服务终结点都支持 PUT 请求和 MERGE 请求。对于 MERGE 请求，可选择设置属性；未显式设置的属性会保留其当前属性。对于 PUT 请求，如果未在对象更新中指定所有必需的属性，则 REST 服务会返回异常。未显式指定的可选属性会设置为其默认属性。
删除资源	DELETE	对特定终结点 URL 使用 HTTP DELETE 命令可删除该终结点表示的 SharePoint 对象。列表、文件和列表项等为可回收对象，可引发回收操作。

构造 REST URL 以访问 SharePoint 资源

SharePoint 使用 REST API。 API 是允许两个应用程序通信的软件中介。每次在手机上使用应用查看天气时，都会使用 API。

要构造 SharePoint REST 服务终结点，请按照以下步骤执行操作：

首先引用 REST 服务：

https://{site_url}/_api
指定相应入口点，例如：

https://{site_url}/_api/web

示例：https://contoso.sharepoint.com/_api/web
从入口点转到要访问的特定资源，包括为与客户端对象模型中的方法对应的终结点指定参数，例如：

https://{site_url}/_api/web/lists/getbytitle('list_name')

示例：https://contoso.sharepoint.com/_api/Lists/getbytitle('TestList')

SharePoint REST 服务