API详细信息¶

认证¶

REST要求对客户端进行身份验证。默认情况下，使用的身份验证方法是基本身份验证。查看 安全性 有关如何更改身份验证方法的部分。

状态代码¶

HTTP请求使用状态代码将请求的结果中继到客户端。在本文档中，不同的状态代码用于不同的目的。这些代码由 HTTP specification .

下面列出了最常见的状态代码及其说明：

格式和表示¶

A format 指定应如何表示特定资源。使用格式：

• 在指定应返回给客户端的表示形式的操作中

• 在POST或PUT操作中，指定要发送到服务器的表示形式

在一个 GET 操作可通过两种方式指定格式。

有两种方法可以指定get操作的格式。第一个选项使用 Accept 标题。例如，将标题设置为 "Accept: text/xml" 资源将作为XML返回。设置格式的第二个选项是通过文件扩展名。例如，给定一个资源 foo ，要求代表 foo 作为XML，请求URI将以 /foo.xml .要请求表示为JSON，请求URI将以 /foo.json .如果没有指定格式，服务器将使用自己的内部格式，通常是HTML。当响应格式同时由头和扩展名指定时，扩展名指定的格式优先。

在一个 POST 或 PUT 操作，将发送到服务器的内容的格式由 Content-type 标题。例如，要以XML形式发送表示，请使用 "Content-type: text/xml" 或 "Content-type: application/xml" .与GET请求一样，从服务器返回的内容的表示由 Accept 标题或按格式。

下表定义了 Content-type 每种格式的值：