一尘不染

使用PHP创建REST API

json

我正在创建我的第一个API,如果向其传递两个值,则应该以JSON格式获取响应。该数字将由POST作为参数传递。使用cURL或任何可用的POST方法。

即使这是非常基础的,我也想知道最佳实践,并且应该基于模型控制器来创建API。不只是普通的PHP。

我已经搜索了许多REST API教程。他们很好,我对此有所了解。

但是,我想获得一个代码示例模型,以便我可以引用它并构建自己的代码,当然,该示例当然是制作真实REST API的标准做法。

如果您问我尝试过的内容,那将非常有趣,作为一个初学者,我所能做的就是:

$num1 = $_REQUEST['num1'];
$num2 = $_REQUEST['num2'];

$total = $num1 + $num2;
echo json_encode($total);

当然,永远不能将其称为API。如果对此给出POST响应,则我希望REST
API的响应为JSON。我也应该能够通过REST控制台对其进行测试,以便获得标准响应。

请为我提供一个非常基本但标准的RESTful API。


阅读 306

收藏
2020-07-27

共1个答案

一尘不染

在您的示例中,它很好,它很简单而且有效。我唯一建议的是:

  1. 验证发布的数据
  2. 确保您的API正在发送Content-Type标头,以告知客户端期望JSON响应:
    header('Content-Type: application/json');
    

    echo json_encode($response);

除此之外,API还需要输入并提供输出。可能使事情“过度工程化”,因为这会使事情变得更加复杂。

如果您想沿用控制器和模型的路线,请继续阅读MVC模式并弄清楚您的领域对象如何适应它。查看上面的示例,我可以看到MathController带有add()操作/方法的。

GitHub上有一些RESTful API的起点项目值得一看。

2020-07-27