README

关于

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

如何创建 composer 包的教程

安装

在您的 composer.json 文件中要求 litermi/response 包，并更新您的依赖项

composer require litermi/response

配置

设置提供者

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

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

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

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

用法

use Litermi\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。