[API Platform Con] Domain Driven Design with API Platform 3

Domain-Driven Design and
API Platform 3
@matarld
@chalas_r

View Slide

chalasr
Mathias Arlaud
@matarld
les-tilleuls.coop
mtarld
Robin Chalas
@chalas_r
les-tilleuls.coop

View Slide

DDD is not
prescriptive.
Mathias Verraes - What is Domain Driven Design
@matarld
@chalas_r

View Slide

However, it is able to ease your life when you have to deal with
complex business expectations .”
“Domain-Driven Design is not a fast way to build software.
DDD ≠ RAD
William Durand - DDD with Symfony 2: Making things clear
@matarld
@chalas_r

View Slide

@matarld
@chalas_r
Directory structure
Directory structure
Directory structure

View Slide

@matarld
@chalas_r
Hexagonal architecture

View Slide

Domain
Models, Value objects, Events,
Repositories
@matarld
@chalas_r

View Slide

Application
Use cases, Application
services, DTOs, Commands,
Queries
Domain
Repositories
@matarld
@chalas_r

View Slide

Application
Use cases, Application
services, DTOs, Commands,
Queries
Domain
Repositories
Infrastructure
Controllers, Databases, Caches,
Vendors
@matarld
@chalas_r

View Slide

Domain integrity is preserved
Code is more testable
Technological decisions can be deferred
Domain is agnostic to the outside world
@matarld
@chalas_r

View Slide

@matarld
@chalas_r
Reading is dreaming with open eyes...
namespace App\BookStore\Domain\Model;
final class Book
{
public readonly BookId $id;
public function __construct(
public BookName $name,
public BookDescription $description,
public Author $author,
public Price $price,
) {
$this->id = new BookId();
}
}

View Slide

PATCH /books/{id}
GET /books
final class Book
{
) {
$this->id = new BookId();
}
}
GET /books/cheapests
DELETE /books/{id}
POST /books/anonymize
POST /books/{id}/discount [...]
@matarld
@chalas_r
Reading is dreaming with open eyes...

View Slide

#[ApiResource(operations: [
new Get(),
new Post('/books/{id}/discount'),
])]
final class Book
{
#[Groups(['book:create'])]
#[Assert\NotBlank]
public ?BookId $id = null;
#[Groups(['book:create', 'book:update'])]
#[Assert\Positive]
public ?Price $price = null,
// ...
) {
$this->id = $id ?? new BookId();
}
}
@matarld
@chalas_r
Simple as sugar cookies?

View Slide

new Get(),
])]
final class Book
{
#[Assert\NotBlank]
#[Assert\Positive]
// ...
) {
}
}
11 warnings
@matarld
@chalas_r

View Slide

new Get(),
])]
final class Book
{
#[Assert\NotBlank]
#[Assert\Positive]
// ...
) {
}
}
11 warnings
7 errors
@matarld
@chalas_r

View Slide

final class Book
{
) {
// ...
}
}
namespace App\BookStore\Infrastructure\ApiPlatform\Resource;
#[ApiResource(operations: [new Get(), new Post('...')])]
final class BookResource
{
#[ApiProperty(identifier: true)]
#[Assert\NotBlank]
public ?Uuid $id = null;
// ...
) {
}
}
@matarld
@chalas_r
From API Platform to the Domain
Model API Resource

View Slide

@matarld
@chalas_r
The Application Layer

View Slide

Model
Domain layer
API resource
Infrastructure layer
Command/Query bus
Application layer
@matarld
@chalas_r
Command/Query pattern

View Slide

@matarld
@chalas_r
Find the
cheapest books.
Use case #1

View Slide

@matarld
@chalas_r
Query and QueryHandler
namespace App\BookStore\Application\Query;
final class FindCheapestBooksQuery
{
public readonly int $size = 10,
) {
}
}
Query
namespace App\BookStore\Application\Query;
final class FindCheapestBooksQueryHandler
{
private BookRepositoryInterface $bookRepository
) {
}
public function __invoke(FindCheapestBooksQuery $query)
{
return $this->bookRepository
->withCheapestsFirst()
->withPagination(1, $query->size);
}
}
QueryHandler

View Slide

new GetCollection('/books/cheapest')
Operation
@matarld
@chalas_r
GET /books/cheapest
API Platform providers
FindCheapestBooksQuery

View Slide

Operation
@matarld
@chalas_r
GET /books/cheapest
FindCheapestBooksQuery
Provider

View Slide

@matarld
@chalas_r
GET /books/cheapest
FooProvider
CheapestBooksProvider
BarProvider
Operation

View Slide

@matarld
@chalas_r
Let's hold the query in the operation!
GET /books/cheapest
FooProvider
BarProvider
new QueryOperation(
'/books/cheapest',
FindCheapestBooksQuery::class,
)
"Query" operation

View Slide

@matarld
@chalas_r
Can we
do better?
Spoiler: yes

View Slide

@matarld
@chalas_r
Providers - the new way
GET /books/cheapest
FooProvider
BarProvider
Operation

View Slide

@matarld
@chalas_r
Let's hold the provider in the operation!
GET /books/cheapest
FooProvider
BarProvider
new GetCollection(
'/books/cheapest',
provider: CheapestBooksProvider::class,
)
Operation

View Slide

@matarld
@chalas_r
Let's hold the provider in the operation!
GET /books/cheapest
new GetCollection(
'/books/cheapest',
)
Operation

View Slide

@matarld
@chalas_r
Domain Appli Infra
Query providers' content
namespace App\BookStore\Infrastructure\ApiPlatform\State\Provider;
final class CheapestBooksProvider implements ProviderInterface
{
/** @return list */
public function provide(...): object|array|null
{
/** @var iterable $models */
$models = $this->queryBus->ask(new FindCheapestBooksQuery());
$resources = [];
foreach ($models as $m) {
$resources[] = BookResource::fromModel($m);
}
return $resources;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

View Slide

@matarld
@chalas_r
Domain Appli Infra
{
/** @return list */
{
$resources = [];
}
return $resources;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/** @return list */
1
2
3
{
4
5
6
{
7
8
9
10
$resources = [];
11
12
13
}
14
15
return $resources;
16
}
17
}
18

View Slide

@matarld
@chalas_r
Domain Appli Infra
{
/** @return list */
{
$resources = [];
}
return $resources;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/** @return list */
1
2
3
{
4
5
6
{
7
8
9
10
$resources = [];
11
12
13
}
14
15
return $resources;
16
}
17
}
18
1
2
3
{
4
/** @return list */
5
6
{
7
8
9
10
$resources = [];
11
12
13
}
14
15
return $resources;
16
}
17
}
18

View Slide

@matarld
@chalas_r
Domain Appli Infra
{
/** @return list */
{
$resources = [];
}
return $resources;
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/** @return list */
1
2
3
{
4
5
6
{
7
8
9
10
$resources = [];
11
12
13
}
14
15
return $resources;
16
}
17
}
18
1
2
3
{
4
/** @return list */
5
6
{
7
8
9
10
$resources = [];
11
12
13
}
14
15
return $resources;
16
}
17
}
18
$resources = [];
}
return $resources;
1
2
3
{
4
/** @return list */
5
6
{
7
8
9
10
11
12
13
14
15
16
}
17
}
18

View Slide

@matarld
@chalas_r
Applying
a discount.
Use case #2

View Slide

@matarld
@chalas_r
Command and CommandHandler
namespace App\BookStore\Application\Command;
final class DiscountBookCommand
{
public readonly Uuid $id,
public readonly int $amount,
) {
}
}
Command
namespace App\BookStore\Application\Command;
final class DiscountBookCommandHandler
{
private BookRepositoryInterface $bookRepository,
) {
}
public function __invoke(DiscountBookCommand $command)
{
// my super complex logic
}
}
CommandHandler

View Slide

@matarld
@chalas_r
Processors - the new way
POST /books/{id}/discount
new Post(
'/books/{id}/discount',
input: DiscountBookPayload::class,
provider: BookItemProvider::class,
)
Operation

View Slide

@matarld
@chalas_r
Processors - the new way
POST /books/{id}/discount
DiscountBookProcessor
new Post(
processor: DiscountBookProcessor::class,
)
Operation

View Slide

@matarld
@chalas_r
Domain Appli Infra
Command processors' content
final class DiscountBookProcessor implements ProcessorInterface
{
/**
* @var DiscountBookPayload $data
* @return BookResource
*/
public function process(...): mixed
{
$this->commandBus->dispatch(new DiscountBookCommand(
id: $context['previous_data']->id,
discountPercentage: $data->discountPercentage,
));
$model = $this->queryBus->ask(new FindBookQuery($command->id));
return BookResource::fromModel($model);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

View Slide

@matarld
@chalas_r
Domain Appli Infra
{
/**
*/
{
));
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/**
*/
1
2
3
{
4
5
6
7
8
9
{
10
11
12
13
));
14
15
16
17
18
}
19
}
20

View Slide

@matarld
@chalas_r
Domain Appli Infra
{
/**
*/
{
));
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/**
*/
1
2
3
{
4
5
6
7
8
9
{
10
11
12
13
));
14
15
16
17
18
}
19
}
20
));
1
2
3
{
4
/**
5
6
7
*/
8
9
{
10
11
12
13
14
15
16
17
18
}
19
}
20

View Slide

@matarld
@chalas_r
Domain Appli Infra
{
/**
*/
{
));
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/**
*/
1
2
3
{
4
5
6
7
8
9
{
10
11
12
13
));
14
15
16
17
18
}
19
}
20
));
1
2
3
{
4
/**
5
6
7
*/
8
9
{
10
11
12
13
14
15
16
17
18
}
19
}
20
1
2
3
{
4
/**
5
6
7
*/
8
9
{
10
11
12
13
));
14
15
16
17
18
}
19
}
20

View Slide

@matarld
@chalas_r
Domain Appli Infra
{
/**
*/
{
));
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/**
*/
1
2
3
{
4
5
6
7
8
9
{
10
11
12
13
));
14
15
16
17
18
}
19
}
20
));
1
2
3
{
4
/**
5
6
7
*/
8
9
{
10
11
12
13
14
15
16
17
18
}
19
}
20
1
2
3
{
4
/**
5
6
7
*/
8
9
{
10
11
12
13
));
14
15
16
17
18
}
19
}
20
1
2
3
{
4
/**
5
6
7
*/
8
9
{
10
11
12
13
));
14
15
16
17
18
}
19
}
20

View Slide

@matarld
@chalas_r
Subscribing to
new books.
Use case #3

View Slide

@matarld
@chalas_r
Bounded contexts
Subscription
BookStore
Payment
Hexagonal
RAD

View Slide

@matarld
@chalas_r
RAD API Platform CRUD
namespace App\Subscription\Entity;
#[ApiResource(operations: [new GetCollection(), new Post()])]
#[ORM\Entity]
class Subscription
{
#[ApiProperty(identifier: true)]
#[ORM\Id]
#[ORM\Column(type: 'uuid', unique: true)]
public ?Uuid $id = null,
#[Assert\NotBlank(groups: ['create'])]
#[Assert\Email(groups: ['create', 'Default'])]
#[ORM\Column(name: 'name', nullable: false)]
public ?string $email = null,
) {
}
}

View Slide

@matarld
@chalas_r
Wrap it up
Domain

View Slide

@matarld
@chalas_r
├── BookStore
│ ├── Application
│ │ ├── Command
│ │ │ ├── CreateSubscriptionCommand.php
│ │ │ ├── CreateSubscriptionCommandHandler.php
│ │ │ ├── DiscountBookCommand.php
│ │ │ ├── DiscountBookCommandHandler.php
│ │ │ └── ...
│ │ └── Query
│ │ ├── FindBookQuery.php
│ │ ├── FindBookQueryHandler.php
│ │ ├── FindCheapestBooksQuery.php
│ │ ├── FindCheapestBooksQueryHandler.php
│ │ └── ...
│ ├── Domain
│ └── Infrastructure
└── Subscription
Wrap it up
Domain
Application

View Slide

@matarld
@chalas_r
├── BookStore
│ │ │ └── ...
│ │ └── Query
│ │ └── ...
├── BookStore
│ └── ApiPlatform
│ ├── Payload
│ │ └── DiscountBookPayload.php
│ ├── Resource
│ │ └── BookResource.php
│ └── State
│ ├── Processor
│ │ ├── AnonymizeBooksProcessor.php
│ │ └── DiscountBookProcessor.php
│ └── Provider
│ ├── BookItemProvider.php
│ └── CheapestBooksProvider.php
Wrap it up
Domain
Application
Infrastructure

View Slide

@matarld
@chalas_r
├── BookStore
│ │ │ └── ...
│ │ └── Query
│ │ └── ...
├── BookStore
│ └── ApiPlatform
│ ├── Payload
│ │ └── DiscountBookPayload.php
│ ├── Resource
│ │ └── BookResource.php
│ └── State
│ ├── Processor
│ │ ├── AnonymizeBooksProcessor.php
│ │ └── DiscountBookProcessor.php
│ └── Provider
│ ├── BookItemProvider.php
│ └── CheapestBooksProvider.php
├── BookStore
└── Entity
└── Subscription.php
Wrap it up
Domain
Application
Infrastructure
RAD

View Slide

@matarld
@chalas_r
Wrap it up
#[ApiResource(
operations: [
new GetCollection(
'/books/cheapest',
),
new Post(
processor: DiscountBookProcessor::class,
),
],
)]
final class BookResource
Business hexagonal
Hexagonal business
#[ApiResource(
operations: [new Get(), new Post()],
)]
final class Subscription
RAD CRUD

View Slide

@matarld
@chalas_r
And it just works!

View Slide

Thanks!
https://github.com/mtarld/apip-ddd
@matarld
@chalas_r
@coopTilleuls

View Slide

[API Platform Con] Domain Driven Design with API Platform 3

[API Platform Con] Domain Driven Design with API Platform 3

Mathias Arlaud

Other Decks in Programming

Featured

Transcript