HTTP et REST : un guide de base pour les débutants

Hypertext Transfer Protocol (HTTP) est la vie du Web. Il est utilisé à chaque transfert de document ou à chaque demande de AJAX . Mais étonnamment, HTTP est relativement méconnu de certains développeurs Web.

Cette introduction démontrera comment l'ensemble des principes de conception REST sous-tend HTTP. Vous apprendrez à libérer toute sa puissance en créant des interfaces pouvant être utilisées sur pratiquement n'importe quel appareil ou système d'exploitation.

Envato Market propose également des milliers de scripts de code, de plugins et d'applications utiles pour vous aider dans le développement Web, tels que Premium URL Shortener, un script PHP que vous pouvez installer sur votre serveur pour créer des URL raccourcies personnalisées.

Pourquoi faire une pause ? REST est un moyen simple d'organiser les interactions entre des systèmes indépendants. Depuis 2005, elle a gagné en popularité et a inspiré la conception de services tels que l'API Twitter. En effet, REST vous permet d'interagir avec une variété de clients, tels que des téléphones mobiles et d'autres sites Web, avec une surcharge minimale. En théorie, REST n’est pas lié au Web, mais il est presque toujours implémenté de cette manière et s’inspire de HTTP. Par conséquent, REST peut être utilisé partout où HTTP peut être utilisé.

Une autre option consiste à créer une convention relativement complexe au-dessus de HTTP. Souvent, cela se manifeste par un langage complètement nouveau. Les exemples les plus marquants sont SOAP et GraphQL. Vous devez apprendre un tout nouvel ensemble de conventions, mais vous ne tirerez jamais le meilleur parti de HTTP. Étant donné que REST s'inspire de HTTP et exploite ses atouts, il s'agit du meilleur moyen de comprendre le fonctionnement de HTTP.

Après ce premier aperçu, nous examinerons chacun des éléments constitutifs de HTTP : les URL, les verbes HTTP et les codes de réponse. Nous verrons également comment les utiliser de manière RESTful. En cours de route, nous illustrerons la théorie avec un exemple d'application qui simule le processus de suivi des données liées aux clients d'une entreprise via une interface Web.

HTTP HTTP est un protocole qui permet d'échanger des documents sur le Web. Un protocole est un ensemble de règles qui déterminent quels messages peuvent être échangés et quels messages constituent des réponses appropriées à d'autres messages. Un autre protocole courant que vous pouvez utiliser pour recevoir des e-mails sur votre disque dur est POP3.

En HTTP, il existe deux rôles différents : serveur et client. De manière générale, une conversation est toujours initiée par le client ; le serveur répond. HTTP est basé sur du texte ; c'est-à-dire que les messages sont essentiellement des morceaux de texte, bien que le corps du message puisse également contenir d'autres médias. Les échanges HTTP peuvent être facilement surveillés à l’aide de texte.

Les messages HTTP se composent d'en-têtes et de corps. Le corps est souvent vide ; il contient les données que vous souhaitez transmettre sur le réseau afin qu'elles puissent être utilisées selon les instructions de l'en-tête. L'en-tête contient des métadonnées telles que des informations de codage ; cependant, pour la requête, il contient également des méthodes HTTP importantes. Dans un style RESTful, vous constaterez que les données d'en-tête sont souvent plus importantes que le corps.

Surveiller HTTP au travail Si vous utilisez les outils de développement Chrome ou Firefox, cliquez sur Réseau dans la barre supérieure pour afficher les requêtes HTTP du site sur lequel vous vous trouvez actuellement. Vous devrez peut-être actualiser la page avec les outils de développement Web ouverts pour afficher les journaux. Par exemple :

Un autre moyen utile de se familiariser avec HTTP consiste à utiliser un client dédié tel que cURL. cURL est un outil de ligne de commande disponible sur tous les principaux systèmes d'exploitation.

Après avoir installé cURL, saisissez :

curl -v google.com Cela affichera la conversation HTTP complète. Les demandes sont précédées de > ，而响应前面是 .

Site Web L'URL est la façon dont vous identifiez le contenu sur lequel vous souhaitez agir. On dit que chaque URL identifie une ressource. Ces URL sont exactement les mêmes que celles attribuées aux pages Web. En fait, une page Web est une ressource.

Prenons un exemple plus sophistiqué et considérons notre exemple d'application, qui gère la liste de clients d'une entreprise. /clients 将识别所有客户端，而 /clients/jim Un client nommé « Jim » sera reconnu, en supposant qu'il soit le seul client à porter ce nom.

Dans ces exemples, nous n'incluons généralement pas le nom d'hôte dans l'URL car cela n'a pas d'importance du point de vue de l'organisation de l'interface. Néanmoins, les noms d'hôte sont importants pour garantir que les identifiants de ressources sont uniques sur le réseau. On dit souvent que vous envoyez des demandes de ressources à l'hébergeur. L'hôte est inclus dans l'en-tête séparément du chemin de la ressource, qui se trouve directement au-dessus de l'en-tête de la requête :

GET /clients/jim HTTP/1.1

Host: example.com Il est préférable de considérer les ressources comme des noms. Par exemple, ce qui suit n'est pas RESTful :

/clients/add C'est parce qu'il utilise des URL pour décrire les actions. C'est un point assez fondamental qui différencie les systèmes RESTful des non-RESTful.

Enfin, les URL doivent être aussi précises que nécessaire ; tout ce qui est nécessaire pour identifier de manière unique la ressource doit être inclus dans l'URL. Vous n'avez pas besoin d'inclure des données identifiant la ressource dans la demande. De cette manière, l’URL agit comme une cartographie complète de toutes les données traitées par l’application.

但是如何指定操作呢？例如，您怎么说您希望创建而不是检索新的客户记录？这就是 HTTP 动词发挥作用的地方。

HTTP 动词 每个请求在请求标头中指定特定的 HTTP 动词或方法。这是请求标头中的第一个全大写单词。例如， GET / HTTP/1.1 表示正在使用 GET 方法，而 DELETE /clients/anne HTTP/1.1 表示正在使用 DELETE 方法。

HTTP 动词告诉服务器如何处理 URL 标识的数据。请求可以选择在其正文中包含执行操作可能需要的其他信息，例如您想要与资源一起存储的数据。您可以使用 -d 选项在 cURL 中提供此数据。

如果您曾经创建过 HTML 表单，您就会熟悉两个最重要的 HTTP 动词： GET 和 POST 。但可用的 HTTP 动词要多得多。构建 RESTful API 最重要的是 GET 、 POST 、 PUT 和 DELETE 。还有其他方法，例如 HEAD 和 OPTIONS ，但比较少见。如果您想了解所有其他 HTTP 方法，官方来源是 IETF。

获取 GET 是最简单的 HTTP 请求方法，浏览器每次单击链接或在地址栏中输入 URL 时都会使用该方法。它指示服务器将 URL 标识的数据传输到客户端。切勿因 GET 请求而在服务器端修改数据。从这个意义上说， GET 请求是只读的，但是当然，一旦客户端收到数据，它就可以自由地在自己这边对其进行任何操作 - 例如，将其格式化以供显示。

放置 当您希望创建或更新由 URL 标识的资源时，将使用 PUT 请求。例如， PUT /clients/robin 可能会在服务器上创建一个名为 Robin 的客户端。您会注意到 REST 完全与后端无关；请求中没有任何内容告诉服务器应该如何创建数据——只是告诉服务器应该如何创建数据。这使您可以在需要时轻松更换后端技术。 PUT 请求包含在主体中更新或创建资源时使用的数据。在 cURL 中，您可以使用 -d 开关将数据添加到请求：

curl -v -X PUT -d "some text" 删除 DELETE 应该执行与 PUT 相反的操作；当您想要删除由请求的 URL 标识的资源时，应该使用它。

curl -v -X DELETE /clients/anne 这将删除与该资源关联的所有数据，由 /clients/anne 标识。

发布 POST 当您希望在服务器上进行的处理应该重复时使用，如果 POST 请求被重复（也就是说，它们不是 幂等 ；更多内容请参见下文） ）。此外， POST 请求应导致将请求正文作为您要发布到的 URL 的下属进行处理。

简单来说， POST /clients/ 不应导致 /clients/ 本身的资源被修改，而是 URL 以 /clients/ 开头的资源被修改 。例如，它可以将一个新客户端附加到列表中，并使用服务器生成的 id ：

/clients/some-unique-id PUT 请求很容易使用，而不是 POST 请求，反之亦然。有些系统仅使用一个，有些系统使用 POST 进行创建操作，使用 PUT 进行更新操作（因为 PUT 要求您始终提供完整的 URL），有些系统甚至使用 POST 进行更新，并使用 PUT 用于创建。

通常， POST 请求用于触发服务器上不符合 Create/Update/Delete 范例的操作，但这超出了 REST 的范围。在我们的示例中，我们将始终使用 PUT 。

HTTP 方法分类 安全和不安全的方法 安全方法是那些从不修改资源的方法。从上面列出的四种方法中，唯一安全的方法是 GET 。其他的不安全，因为它们可能会导致资源的修改。

幂等方法 无论重复请求多少次，这些方法都会获得相同的结果：它们是 GET 、 PUT 和 DELETE 。唯一的非幂等方法是 POST 。

PUT 和 DELETE 被认为是幂等的可能会令人惊讶，但这很容易解释。使用相同的主体重复 PUT 方法应该以与上一个 PUT 请求中描述的方式相同的方式修改资源：不会有任何改变！同样，删除一个资源两次也是没有意义的。因此，无论重复 PUT 或 DELETE 请求多少次，结果都应该与只执行一次相同。

记住： 最终决定使用某种 HTTP 方法时会发生什么情况的是程序员。 HTTP 实现中没有任何固有的东西会自动导致资源被创建、列出、删除或更新。您必须小心地正确应用 HTTP 协议并自行强制执行这些语义。

表示 我们可以通过以下方式总结到目前为止所学到的知识：HTTP 客户端和 HTTP 服务器交换有关由 URL 标识的资源的信息。

我们说请求和响应包含资源的表示。通过表示，我们指的是某种格式的有关资源状态或该状态未来应如何的信息。标头和正文都是表示的一部分。

包含元数据的 HTTP 标头由 HTTP 规范严格定义；它们只能包含纯文本，并且必须以某种方式格式化。

正文可以包含任何格式的数据，这就是 HTTP 真正发挥作用的地方。您知道可以用任何人类语言发送纯文本、图片、HTML 和 XML。通过请求元数据或不同的 URL，您可以选择同一资源的不同表示形式。例如，您可以将网页发送到浏览器，并将 JSON 发送到应用程序。

HTTP 响应应指定正文的内容类型。这是在标头的 Content-Type 字段中完成的。例如：

Content-Type: application/json 为简单起见，我们的示例应用程序仅来回发送 JSON，但应用程序的设计方式应使您可以轻松更改数据格式，以适应不同的客户端或用户偏好。

HTTP 客户端库 要尝试不同的请求方法，您需要一个客户端，它允许您指定要使用的方法。不幸的是，HTML 表单不符合要求，因为它们只允许您发出 GET 和 POST 请求。在现实生活中，API 是通过单独的客户端应用程序或通过浏览器中的 JavaScript 以编程方式访问的。

这就是为什么除了服务器之外，在您选择的编程语言中拥有良好的 HTTP 客户端功能也很重要。

一个非常流行的 HTTP 客户端库是 cURL。您已经在本教程前面熟悉了 cURL 命令。 cURL 包括一个独立的命令行程序和一个可供各种编程语言使用的库。特别是，cURL 通常是 PHP 开发人员选择的 HTTP 客户端解决方案。其他语言（例如 Python）提供更多本机 HTTP 客户端库。

设置示例应用程序 现在我们将构建一个准系统示例应用程序。您可以按照相应部分并使用代码附件中的相应文件夹，在 Node.js 或 PHP 中构建示例应用程序。两个应用程序的工作方式相同。如果您不确定选择哪个，Node.js 可能是更好的选择，因为它现在更常用。

Node.js 和 Express 为了运行示例应用程序，您需要安装 Node.js。完成后，打开源代码附件中的 node.js 目录并运行 npm install 。

PHP 要运行示例应用程序，您需要安装 PHP 5 和具有某种运行 PHP 机制的 Web 服务器。当前版本必须至少为 5.2 版本才能访问 json_encode() 和 json_decode() 函数。

对于服务器，最常见的选择仍然是 Apache 和 mod_php ，但您可以自由地使用您喜欢的任何替代方案。有一个 Apache 配置示例，其中包含重写规则，可帮助您快速设置应用程序。对任何以 /clients/ 开头的 URL 的所有请求都必须路由到我们的 server.php 文件。

在 Apache 中，您需要启用 mod_rewrite 并将提供的 mod_rewrite 配置放在您的 Apache 配置或 .htacess 中的某个位置 文件。这样， server.php 将响应来自服务器的所有请求。必须使用 Nginx 或您决定使用的任何替代服务器来实现同样的效果。

示例应用程序如何工作 Node.js 和 Express 如果你查看代码，你会看到一些不同的方法，例如 app.get 或 app.put 。这些是不同的路线。每个路由都匹配特定的 URL 和 HTTP 方法。

app.get("/clients", (_, res) => { ... }); app.get("/clients/:client", (req, res) => { ... }); app.put("/clients/:client", (req, res) => { ... }); app.delete("/clients/:client", (req, res) => { ... }); 您可能已经注意到 URL 中的 :client 。这是一个参数，这意味着 URL 该部分中的任何内容都将与该路由匹配，并且 URL 该部分将作为参数传递。在路由处理函数内部，您可以看到描述逻辑的注释。最后是 app.listen 。

app.listen(port, () => { console.log(`Example app listening on port ${port}`); }); 这将在 port 指定的端口启动服务器。回调函数在服务器启动后执行。

PHP 以 REST 方式处理请求有两个关键。第一个关键是根据 HTTP 方法启动不同的处理 - 即使 URL 相同。在 PHP 中， $_SERVER 全局数组中有一个变量，用于确定使用哪种方法发出请求：

$_SERVER['REQUEST_METHOD'] 此变量包含字符串形式的方法名称，例如 'GET' 、 'PUT' 等。

另一个关键是知道请求的是哪个 URL。为此，我们使用另一个标准 PHP 变量：

$_SERVER['REQUEST_URI'] 此变量包含从第一个正斜杠开始的 URL。例如，如果主机名是 example.com ，则 'https://example.com/' 将返回 '/' ，而 'http://example.com/test/ ' 将返回 '/test/' 。

我们首先尝试确定调用了哪个 URL。我们只考虑以 'clients' 开头的 URL。其他均无效。

$resource = array_shift($paths);

if ($resource == 'clients') { $name = array_shift($paths);

if (empty($name)) { $this->handle_base($method); } else { $this->handle_name($method, $name); }

} else { // We only handle resources under 'clients' header('HTTP/1.1 404 Not Found'); } 我们有两种可能的结果：

资源就是客户，在这种情况下，我们会返回完整的列表。 还有一个进一步的标识符。 如果有其他标识符，我们假设它是客户端的名称，并再次将其转发到不同的函数，具体取决于 方法 。我们使用 switch 语句，在实际应用程序中应该避免这种情况：

switch($method) { case 'PUT': $this->create_contact($name); break;

case 'DELETE': $this->delete_contact($name); break;

case 'GET': $this->display_contact($name); break;

default: header('HTTP/1.1 405 Method Not Allowed'); header('Allow: GET, PUT, DELETE'); break; } 响应代码 您可能已经注意到，示例应用程序使用 PHP header() ，传递一些看起来奇怪的字符串作为参数。 header() 函数打印 HTTP headers 并确保它们的格式正确。标头应该是响应中的第一件事，因此在完成标头之前不应输出任何其他内容。有时，除了您在代码中指定的标头之外，您的 HTTP 服务器可能会配置为添加其他标头。

标头包含各种元信息，例如消息正文中使用的文本编码或正文内容的 MIME 类型。在本例中，我们显式指定 HTTP 响应代码。 HTTP 响应代码标准化了一种通知客户端请求结果的方法。默认情况下，PHP返回 200 响应码，表示响应成功。

服务器应该返回最合适的HTTP响应代码；这样，客户端可以尝试修复其错误（假设有任何错误）。大多数人都熟悉常见的 404 Not Found 响应代码，但还有更多可用的代码可以适应各种情况。

请记住，HTTP 响应代码的含义并不是非常精确；这是 HTTP 本身相当通用的结果。您应该尝试使用与当前情况最匹配的响应代码。话虽如此，如果您找不到完全合适的产品，也不必太担心。

以下是一些经常与 REST 一起使用的 HTTP 响应代码：

200 好的 此响应代码表明请求成功。

201已创建 这表明请求成功并且资源已创建。用于确认 PUT 或 POST 请求是否成功。

400 错误请求 请求格式错误。当数据未通过验证或格式错误时，尤其是在 POST 和 PUT 请求中，会发生这种情况。

404 未找到 此响应表明无法找到所需的资源。这通常会返回给所有指向没有相应资源的 URL 的请求。

401 未经授权 此错误表明您需要在访问资源之前执行身份验证。

405 方法不允许 此资源不支持所使用的 HTTP 方法。

409 冲突 这表明存在冲突。例如，您使用 PUT 请求两次创建相同的资源。

500 内部服务器错误 当一切都失败时；一般情况下，500响应是由于服务器端出现意外情况导致处理失败，导致服务器出错时使用的。

练习示例应用程序 我们首先从应用程序中获取信息。我们需要客户端 'jim' 的详细信息，因此让我们向此资源的 URL 发送一个简单的 GET 请求：

curl -v http://localhost:80/clients/jim 这将显示完整的消息标题。响应中的最后一行将是消息正文；在本例中，它将是包含 Jim 地址的 JSON（请记住，省略方法名称将导致 GET 请求；同时将 localhost:80 替换为您正在使用的服务器名称和端口）。

接下来，我们可以一次性获取所有客户的信息：

curl -v http://localhost:80/clients/ 然后我们创建一个新客户端，名为 Paul：

curl -v -X "PUT" http://localhost:80/clients/paul -d '{"address":"Sunset Boulevard" }' -H 'content-type: application/json' 现在您将收到包含 Paul 的所有客户的列表作为确认。

最后，删除客户端：

curl -v -X "DELETE" http://localhost:80/clients/anne 您会发现返回的JSON不再包含有关Anne的任何数据。

如果您尝试检索不存在的客户端，例如：

curl -v http://localhost:80/clients/jerry 您将收到 404 错误，而如果您尝试创建已存在的客户端：

curl -v -X "PUT" http://localhost:80/clients/anne 您将收到 409 错误。

结论 重要的是要记住，HTTP 被设计为在除了对协议的理解之外不共享任何内容的系统之间进行通信。一般来说，您对 HTTP 之外的假设越少越好：这允许最广泛的程序和设备访问您的 API。

J'utilise PHP dans ce didacticiel car c'est probablement le langage le plus familier aux lecteurs d'Envato Tuts+. Cela dit, PHP, bien que conçu pour le Web, n'est peut-être pas le meilleur langage pour travailler de manière RESTful car il gère PUT 请求的方式与 GET 和 POST complètement différemment.

En plus de PHP et Node.js, vous pouvez également considérer les éléments suivants :

Vous recherchez un serveur Web plus performant. Divers frameworks Ruby (Rails et Sinatra). Python car il a un bon support REST. Plain Django et WebOb ou Werkzeug devraient fonctionner. Parmi les applications qui tentent d'adhérer aux principes REST, l'exemple classique est le protocole de publication Atom, même si, pour être honnête, il n'est pas très souvent utilisé dans la pratique. Pour les applications modernes construites sur l'idée d'utiliser pleinement HTTP, voir Apache CouchDB.

Amusez-vous bien !

Cet article a été mis à jour avec une contribution de Jacob Jackson. Jacob est un développeur Web, un rédacteur technique et un contributeur open source fréquent.

HTTP et REST : un guide de base pour les débutants

Articles Liés