阅读 163

Laravel REST API 响应生成器

文章转发自专业的Laravel开发者社区,原始链接:learnku.com/laravel/t/3…

用于Laravel的REST API 响应生成器是 Marcin Orlowski的一个软件包,用来构建JSON API响应。根据作者的说法,该软件包可帮助您进行数据转换和本地化等工作:

ResponseBuilder 是由 REST API 开发人员为那些 REST API 开发者而编写的扩展包,它基于我对各种 REST API 开发「双方」(API 开发人员和 API 消费者)的长期经验。它的特点在于:轻量级,具有简单易用的公共方法,涵盖多个潜在的用例,即时的数据转换,本地化的支持,自动错误信息的构建,对链式 API 的支持,以及(我希望如此) 详尽的文档。

这个包提供的最简单的例子是从控制器中返回以下内容:

return ResponseBuilder::success();

复制代码

生成的客户端JSON如下所示:

{
  “success”: true,
  “code”: 0,
  “locale”: “en”,
  “message”: “OK”,
  “data”: null
}

复制代码

如果你想要为API中的常见错误构建消息代码,则可以执行以下操作:

return ResponseBuilder::error(MyErrorCodes::SOME_CODE);

复制代码

如果你传递了 205错误码,则会显示以下信息:

{
   “success”: false,
   “code”: 205,
   “locale”: “en”,
   “message”: “Your error message for code 250”,
   “data”: null
}

复制代码

查阅详情 文件 有关这个包的更多案例,你可以了解这个包的更多信息,获取完整的安装说明,并在 GitHub 上查看源代码 MarcinOrlowski/laravel-api-response-builder.

关注下面的标签,发现更多相似文章
评论