cirelramos/response

Response是一个用于响应api-rest的包。

1.0.2 2022-05-07 02:56 UTC

This package is auto-updated.

Last update: 2024-09-07 07:42:57 UTC


README

Software License

关于

Response是一个用于响应api-rest的包。

如何创建composer包的教程

安装

在您的composer.json中要求cirelramos/response包,并更新您的依赖关系

composer require cirelramos/response

配置

设置提供者

'providers' => [
    // ...
    Cirelramos\Response\Providers\ServiceProvider::class,
],

默认设置在config/response.php中。发布配置以将文件复制到您自己的配置中

php artisan vendor:publish --provider="Cirelramos\Response\Providers\ServiceProvider"

注意:这是必要的,以便您可以更改默认配置

用法

use Cirelramos\Response\Traits\ResponseTrait;

class Controller extends BaseController
{
    use ResponseTrait;
    //.
    //.
    //.
}
Class ProductController extends Controller
{
    //.
    //.
    //.
    
    public function store(ProductRequest $request){
             
        $successMessage = _('OPERATION_SUCCESSFUL_MESSAGE');
        $errorMessage   = _('AN_ERROR_HAS_OCCURRED_MESSAGE');

        try {
            DB::beginTransaction();

            $product = new Product();
            $product->fill($request->validated());
            $product->save();
            DB::commit();

            $data[ 'product' ] = new ProductResource($product);

            return $this->successResponseWithMessage($data, $successMessage, Response::HTTP_CREATED);

        }
        catch(Exception $exception) {
            DB::rollBack();

            return $this->errorCatchResponse($exception, $errorMessage, Response::HTTP_SERVICE_UNAVAILABLE);
        }
    }

    //.
    //.
    //.
}

许可证

在MIT许可证下发布,请参阅LICENSE