README

此包使创建 Laravel 5.5+、6.x、7.x 和 8.x 的 rest api 响应变得简单。

内容

• 安装
• 使用
  • 可用宏
  • 示例响应
  • 示例
  • 配置
• 变更日志
• 测试
• 安全性
• 贡献
• 致谢
• 许可

安装

通过 Composer

$ composer require eozden/api-response

或者，您可以选择手动更新 require 块并运行 composer update

{
    "require": {
        "eozden/api-response": "^1.0"
    }
}

使用

可用宏

response()->ok($data = null, int $code = null);
response()->error($data = null, int $code = null);

示例响应

{
  "success": true,
  "code": 200,
  "locale": "en",
  "message": "OK",
  "data": null
}

{
  "success": false,
  "code": 422,
  "locale": "en",
  "message": "UNPROCESSABLE ENTITY",
  "data": null
}

示例

public function delete()
{
    User::find(1)->delete();

    return response()->ok();
}

配置

return [

    /**
     * Default response code settings
     */ 
    "default" => [
        "ok" => \Eozden\ApiResponse\ResponseStatus::OK,
        "error" => \Eozden\ApiResponse\ResponseStatus::UNPROCESSABLE_ENTITY,
    ],
    
    /**
     * Force to use middleware to return response as a json
     */ 
    "force" => true,
    
    /**
     * You can add your custom HTTP Status Codes
     */ 
    "map" => [
        \Eozden\ApiResponse\ResponseStatus::OK => "ok",
        \Eozden\ApiResponse\ResponseStatus::CREATED => "created",
        \Eozden\ApiResponse\ResponseStatus::ACCEPTED => "accepted",
        \Eozden\ApiResponse\ResponseStatus::NO_CONTENT => "no_content",
        \Eozden\ApiResponse\ResponseStatus::NOT_MODIFIED => "not_modified",
        \Eozden\ApiResponse\ResponseStatus::BAD_REQUEST => "bad_request",
        \Eozden\ApiResponse\ResponseStatus::UNAUTHORIZED => "unauthorized",
        \Eozden\ApiResponse\ResponseStatus::FORBIDDEN => "forbidden",
        \Eozden\ApiResponse\ResponseStatus::NOT_FOUND => "not_found",
        \Eozden\ApiResponse\ResponseStatus::CONFLICT => "conflict",
        \Eozden\ApiResponse\ResponseStatus::UNPROCESSABLE_ENTITY => "unprocessable_entity",
        \Eozden\ApiResponse\ResponseStatus::INTERNAL_SERVER_ERROR => "internal_server_error"
    ]
];

变更日志

请参阅 CHANGELOG 了解最近的变化。

测试

$ composer test

安全性

如果您发现任何与安全相关的问题，请通过电子邮件 enes@emarka.com.tr 而不是使用问题跟踪器来报告。

贡献

请参阅 CONTRIBUTING 获取详细信息。

致谢

• Enes Özden
• 所有贡献者

许可

MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。