graphicode/standard

graphicode laravel 团队的标准工具

维护者

详细信息

github.com/AhmedFekry98/laravel-gcode-standard

源代码

问题

安装: 82

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放性问题: 0

V3.0 2024-05-27 01:45 UTC

Requires

MIT 76eb0beb6da117e58fd43aa87db5641f772295f3

  • AhmedFekry98 <AhmedFekry.woop@graphicode.com>

This package is auto-updated.

Last update: 2024-09-30 07:57:33 UTC

README


---

要求

  • php >=8.0
  • laravel 框架 >=10.10

----

安装

使用此命令现在尝试此包

    composer require graphicode/standard v3.0

发布语言文件

    php artisan vendor:publish --tag="gcstandard-lang"

---

ApiResponse 特性

此特性用于使 API 响应更简洁。

准备控制器使用此特性

<?php

namespace App\Http\Controllers;

use Graphicode\Standard\Traits\ApiResponses;

class TestController extends Controller
{
    use ApiResponses;

    public function index()
    {
        return $this->okResponse(data: [], message: "hello, api");
    }
}



可用方法

    /**
    * 200 Ok response
    *
    * @param $data
    * @param $message
    **/
    return $this->okResponse(data: "data", message: "message");

    /**
    * 201 resource created
    *
    * @param $data
    * @param $message
    **/
    return $this->createdResponse(data: "data", message: "message");

    /**
    * 400 bad response
    *
    * @param $data
    * @param $message
    **/
    return $this->badResponse(data: "data", message: "message");

    /**
    * 201 unauthorized
    *
    * @param $data
    * @param $message
    **/
    return $this->unauthenticatedResponse(data: "data", message: "message");