使用PHP和Laravel创建REST API-DEV365 开发者社区

PHP于1995年出现，仅次于Java。如今，两者都仍然是十种最受欢迎的语言。借助PHP的一般易用性，的选项如何比比皆是。但是，并非每个PHP教程都是平等创建的。这就是为什么我们将这个对初学者友好的Postman Quickstarts tutorial组合在一起，以使用PHP构建REST API。为此，我们使用我们认为是一个直接的框架：Laravel。

Laravel是一种流行的PHP Web应用程序框架，配备了各种内置工具和构建API的功能。在本教程中，我们将创建一个简单的API，允许用户添加和检索数据。

我们开始之前

仔细检查您准备在PHP中写入。本教程仅需要一个基本的熟悉度，而PHP为新用户具有众所周知的平坦学习曲线。我们鼓励您尝试任何技能水平。

接下来，确认已安装以下内容：

Git（必需）
PHP（必需）
Composer（必需）
Homebrew（仅用于Mac）

如果您想逐步安装上述任何一个，请参阅full Laravel API quickstart guide at Postman. Plus，您还希望打开您喜欢的代码编辑器。现在，让我开始！

步骤1：开始您的Laravel项目

脚手架您的Laravel项目

在我们编写任何代码之前，我们需要为Laravel项目划掉。多亏了作曲家，这相对简单。打开一个终端并导航到该项目将居住的目录。在终端中输入以下命令：

composer create-project laravel/laravel laravel_project

这可能需要一些时间。有数十兆字节要下载和安装。

完成后，您将拥有一个名为laravel_project的项目文件夹。

给它测试

导航到laravel_project文件夹，然后在终端中输入以下命令：

php artisan serve --port=8080

这将在http://localhost:8080启动您的项目。如果您已经使用端口有一个过程，则将端口更改为其他东西。运行时，请访问URL。它将返回此主页。

在右下角注意，您会看到Laravel和PHP版本号。如果您正在寻找教程，请找到与这些版本尽可能接近的Laravel和PHP的教程，将有助于最大程度地减少问题。

让我们继续添加API。

步骤2：构建API

创建路线

这将创建一个没有身份验证的公共API。

在编辑器中的Laravel项目目录中打开routes/api.php。最后添加以下代码：

Route::get('/hello', function () {
  return "Hello World!";
});

这添加了/api/hello端点，并在纯文本中返回“ hello world”到get请求。

请注意Laravel如何将端点与/api前缀。

接下来，让我们在Postman中调用此端点。

步骤3：尝试第一个终点

要在Postman中进行测试，请打开您的个人工作区并开始收集。将其命名为“ Laravel Quickstart”或您喜欢的其他内容。

创建后，选择添加请求开始。

将请求URL设置为localhost:8080/api/hello，并确保您的邮递员桌面代理应用程序在计算机上运行，以防止在本地测试时任何CORS问题。

选择 send 和请求部分下方的响应部分将以纯文本显示Hello World!的响应，并带有200 OK响应代码。

恭喜。您在Laravel中创建了第一个API端点，并与Postman成功称呼它。

接下来，让我们做一个有趣的帖子端点。

步骤4：添加帖子端点

返回到您的routes/api.php文件，添加以下内容：

Route::post('/reverse-me', function (Request $request) {
  $reversed = strrev($request->input('reverse_this'));
  return $reversed;
});

这为端点api/reverse-me添加了一条后路由。它将用参数名称reverse_this逆转您在帖子正文中传递的字符串。

让我们在下一节中尝试一下。

步骤5：尝试您的帖子端点

在Postman中返回您的Laravel Quickstart Collection，并添加请求。将其命名为“反向”并按照以下步骤：

将请求类型设置为POST。
将端点设置为localhost:8080/api/reverse-me。
选择身体 tab。
在选项卡中的“顶级下拉菜单”中，选择 x-www-form-urlencoded 。
添加具有esrever值的reverse_this的参数。那是“反向”已经逆转了，因此返回值很容易阅读。
选择发送

API将以纯文本返回字符串反向。恭喜！您可以使用PHP和Laravel创建REST API。

概括

在这篇博客文章中，我们探索了如何使用Laravel框架创建简单的基于PHP的API。我们创建了GET和POST API端点，并使用Postman来测试这些端点。通过遵循本教程，您现在应该对如何使用Laravel创建基本API以及如何使用Postman进行测试。

走得更远

如果您想加深对Laravel和Postman的了解，请尝试以下练习：

潜入Laravel 10.x documentation中，添加一个控制器来处理更复杂的请求和/或添加模型以连接数据库。
查看Laravel 10.x error handling documentation以学习Laravel中错误处理的最佳实践，例如，如果有人提交了二进制文件而不是字符串，可能会发生什么。
探索Postman testing documentation并在邮政请求上编写测试，以确保reverse_ter_tern的字符串被正确逆转。

查看Postman Quickstarts，以获取更多类似的分步指南。如果您想自己做出贡献，请前往Github上的Postman Quickstarts repo。