Laravel REST API 响应生成器


用于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.

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://laravel-news.com/laravel-rest-ap...

译文地址:https://learnku.com/laravel/t/35917

本帖已被设为精华帖!
本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 1

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!