Fix API messages format

Author: roxblnfk

src/Api/External/Controller/ApiController.php

@@ -5,6 +5,7 @@
 namespace App\Api\External\Controller;
 
 use App\Api\External\Data\ErrorBucket;
+use App\Api\External\Exception\HttpException;
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -15,6 +16,7 @@
 use roxblnfk\SmartStream\SmartStreamFactory;
 use RuntimeException;
 use Throwable;
+use Yiisoft\Http\Status;
 use Yiisoft\Injector\Injector;
 
 abstract class ApiController implements MiddlewareInterface
@@ -38,7 +40,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         try {
             $callable = [$this, $request->getMethod()];
             if (!is_callable($callable)) {
-                throw new RuntimeException('Method not allowed.');
+                throw new HttpException(Status::METHOD_NOT_ALLOWED, 'Method not allowed.');
             }
             $data = $this->injector->invoke($callable, [$request]);
         } catch (Throwable $e) {
@@ -48,7 +50,11 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
     }
 
     protected function errorToBucket(Throwable $error): DataBucket {
-        return new ErrorBucket($error, true);
+        $bucket = new ErrorBucket($error, false);
+        if ($error instanceof HttpException) {
+            $bucket = $bucket->withStatusCode($error->getStatus());
+        }
+        return $bucket;
     }
 
     protected function prepareResponse($data, ?ServerRequestInterface $request = null): ResponseInterface

src/Api/External/Data/ApiBucket.php

@@ -8,4 +8,14 @@
 
 class ApiBucket extends DataBucket
 {
+    public function getData(): array
+    {
+        return [
+            'success' => true,
+            'status' => $this->getStatusCode() ?? 200,
+            'data' => $this->data,
+            'code' => null,
+            'message' => null,
+        ];
+    }
 }

src/Api/External/Data/ErrorBucket.php

@@ -18,10 +18,11 @@ public function __construct(\Throwable $error, bool $modeDev = false)
 
     public function getData(): array
     {
-        $data = [
-            'code' => $this->error->getCode(),
-            'message' => $this->error->getMessage(),
-        ];
+        $data = parent::getData();
+        $data['success'] = false;
+        $data['data'] = null;
+        $data['code'] = $this->error->getCode();
+        $data['message'] = $this->error->getMessage();
         if ($this->modeDev) {
             $data['file'] = $this->error->getFile();
             $data['line'] = $this->error->getLine();

src/Api/External/Exception/HttpException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Api\External\Exception;
+
+use Exception;
+use Throwable;
+
+class HttpException extends Exception
+{
+    private int $status;
+    public function __construct(int $status = 500, $message = "", $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+        $this->status = $status;
+    }
+    public function getStatus(): int
+    {
+        return $this->status;
+    }
+}