l0gicgate
commented
3 years ago Sure let's do a simple signup endpoint for example:
Let's add a signup route
routes.php
$app->post('/sign-up', SignUpUserAction::class);Create src/Application/Validation folder
Let's make an abstract validator so we can extend it for specific use cases like below. You'll need to install webmozart/assert via composer for this code to work:
src/Application/Validation/Validator.php
<?php
declare(strict_types=1);
namespace App\Application\Validation;
use InvalidArgumentException;
abstract class Validator
{
/**
* @throws ValidationException
*/
public function validate(array $data): void
{
try {
$this->__validate($data);
} catch (InvalidArgumentException $exception) {
throw new ValidationException($exception->getMessage());
}
}
/**
* @throws InvalidArgumentException
*/
abstract public function __validate(array $data): void;
}
Named Validator Exception src/Application/Validation/ValidationException.php
<?php
declare(strict_types=1);
namespace App\Application\Validation;
use App\Application\Exception\ApplicationException;
class ValidationException extends ApplicationException
{
}SignUp Validator src/Application/Validation/User/SignUpValidator.php
<?php
declare(strict_types=1);
namespace App\Application\Validation\User;
use App\Application\Validation\Validator;
use Webmozart\Assert\Assert;
class SignUpValidator extends Validator
{
public function __validate(array $data): void
{
Assert::stringNotEmpty($data['firstName'], 'Field `firstName` cannot be empty.');
Assert::maxLength($data['firstName'], 255, 'Field `firstName` be longer than 255 characters.');
Assert::stringNotEmpty($data['lastName'], 'Field `lastName` cannot be empty.');
Assert::maxLength($data['lastName'], 255, 'Field `lastName` cannot be longer than 255 characters.');
Assert::stringNotEmpty($data['username'], 'Field `username` cannot be empty.');
Assert::maxLength($data['username'], 255, 'Field `username` cannot be longer than 255 characters.');
}
}Now let's modify the base action class to capture ValidationException so it can rethrow it as an HttpBadRequestException:
Action.php
src/Application/Actions/Action.php
<?php
declare(strict_types=1);
namespace App\Application\Actions;
use App\Domain\DomainException\DomainRecordNotFoundException;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Log\LoggerInterface;
use Slim\Exception\HttpBadRequestException;
use Slim\Exception\HttpNotFoundException;
abstract class Action
{
/**
* @var LoggerInterface
*/
protected $logger;
/**
* @var Request
*/
protected $request;
/**
* @var Response
*/
protected $response;
/**
* @var array
*/
protected $args;
/**
* @param LoggerInterface $logger
*/
public function __construct(LoggerInterface $logger)
{
$this->logger = $logger;
}
/**
* @param Request $request
* @param Response $response
* @param array $args
* @return Response
* @throws HttpNotFoundException
* @throws HttpBadRequestException
*/
public function __invoke(Request $request, Response $response, array $args): Response
{
$this->request = $request;
$this->response = $response;
$this->args = $args;
try {
return $this->action();
} catch (DomainRecordNotFoundException $e) {
throw new HttpNotFoundException($this->request, $e->getMessage());
} catch (ValidationException $e) {
throw new HttpBadRequestException($this->request, $e->getMessage());
}
}
// Replace the original getFormData() method with this one
protected function getFormData(): array
{
return $this->request->getParsedBody() ?? [];
}
}SignUpAction: src/Application/Actions/User/SignUpAction.php
<?php
declare(strict_types=1);
namespace App\Application\Actions\User;
use App\Application\Validation\User\SignUpValidator;
use App\Domain\User\User;
use App\Domain\User\UserRepository;
use Psr\Http\Message\ResponseInterface as Response;
class SignUpAction extends UserAction
{
protected function action(): Response
{
$data = $this->getFormData();
$validator = new SignUpValidator();
$validator->validate($data);
// I'm not going to go into the persistence of the user here because
// I don't know what you're using to store stuff in your database
// If you're using an ORM this should be fairly easy though.
$user = new User(1, $data['firstName'], $data['lastName'], $data['username']);
$this->userRepository->store($user);
return $this->respondWithData($user);
}
}A sample request would be:
POST /sign-up
Content-Type: application/json
{"firstName": "John", "lastName": "Doe", "username": "johndoe"}
Guyverix
I have been learning a lot by using your skeleton, however I am having some trouble with POST.
The GET makes sense, but since I am not a real developer, I am having a tough time making a POST without the application barfing on my ignorance. Any chance that a POST in the routes can be added with a simple/complete example?