Chapters

36 Chapters | 3:44:20 |

01

Setup & Ways to Extend API Platform

4:39
02

State Providers, Processors & a Custom Field

4:49
03

Decorating the Core State Provider

4:47
04

Decorating the CollectionProvider

7:12
05

Simpler State Processor

5:47
06

Running Code "On Publish"

6:05
07

Totally Custom Resource

4:19
08

Custom Resource State Provider

5:04
09

Using a Custom (Date) Identifier

7:35
10

Custom Resource Item Provider

3:26
11

Custom Resource State Processor

6:48
12

Relating Custom ApiResources

5:13
13

Embedding Custom DTO's

4:47
14

Pagination on a Custom Resource

8:18
15

User Class Dto

4:24
16

stateOptions + entityClass Magic

10:07
17

Entities, DTO's & The "Central" Object

6:24
18

Provider: Transforming Entities to DTOs

4:47
19

Entity -> DTO Item State Provider

4:11
20

DTO -> Entity State Processor

7:39
21

Leveraging the Core Processor

7:11
22

Controlling Fields without Groups

4:31
23

Other Conditional Field Strategies

6:04
24

DTO Validation & Security

6:13
25

MicroMapper: Central DTO Mapping

10:11
26

Reusable Entity->Dto Provider & Processor

4:11
27

Quick! Create a DragonTreasure DTO

9:51
28

Dtos, Mapping & Max Depth of Relations

8:05
29

Making DragonTreasureApi Writable

7:23
30

DTO & Security

9:39
31

Field Security with Patch

6:17
32

Triggering a "Publish"

4:14
33

Writable Relation Fields

5:09
34

Writing to a Collection Relation

5:08
35

Writable Collection via the PropertyAccessor

6:29
36

Simpler Validator for Checking State Change

7:23

> APIs > API Platform 3 Part 3: Custom Resources

Buy Access to Course

16.

stateOptions + entityClass Magic

|

|

Autoplay

Keep on Learning!

If you liked what you've learned so far, dive in! Subscribe to get
access to this tutorial plus video, code and script downloads.

Start your All-Access Pass

Buy just this tutorial for $12.00

Previous Chapter

Next Chapter

With a Subscription, click any sentence in the script to jump to that part of the video!

Login Subscribe

Login or register to check out the script

7 Comments

Sort By

Login or Register to join the conversation

Guillaume 2 years ago edited

Hi, I'm afraid this is not working (anymore? I'm on Api Platform Core version 3.2.13).

With this code :

<?php

namespace App\ApiResource;

use App\Entity\User;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Doctrine\Orm\State\Options;
use ApiPlatform\Doctrine\Orm\State\CollectionProvider;

#[ApiResource(
    shortName: 'User',
    provider: CollectionProvider::class,
    stateOptions: new Options(entityClass: User::class)
)]
class UserApi
{
    public ?int $id = null;
}

I have the full Doctrine entity for Get and GetCollection.

If I remove the provider option, the Get results as expected (only the id property) but the GetCollection still presents all the Doctrine entity properties.

1 |

weaverryan SFCASTS Guillaume 2 years ago

Hey @Guillaume!

Sorry for the trouble and the late reply. I just had some time to look into this and I can confirm your bug. It looks like there's already an issue open - https://github.com/api-platform/core/issues/6039#issuecomment-1959624424 - and I've added a bunch more detail. Hopefully the problem can be identified and fixed.

Cheers!

1 |

Guillaume weaverryan 2 years ago

I'm relieved I'm not in cause there ;-)
Thank you for taking action to help fix the issue! :-) Your tutorial helps me so much in my journey learning to use Api Platform!

|

Jeremy 2 years ago edited

Hi!

The type hint annotation didn't work for me while writing (POST), but working while reading (GET).
(POST client with this data : {"addresses": [..., ...]}} ) ended up with bad conversion error because he was expecting an array of strings instead of an array of data. And it couldn't understand IRI either.

I had to manualy define the ApiProperty definition :

/**
 * @var array<int, AddressApi>
 * This annotation is not working
 */
#[ApiProperty(
    writableLink: true,
    builtinTypes: [
        new Type(
            'object',
            collection: true,
            collectionKeyType: [new Type('int')],
            collectionValueType: new Type('object', class: AddressApi::class)
        )
    ]
)]
public array $addresses = [];

I hope this could help anyone !
By browsing this tutorial, I couldn't find a case where you do post embedded data since you separated Entities from ApiResources, so I can't figure if the problem is from my side or not.

Kind regards,

Jérémy

1 |

weaverryan SFCASTS Jeremy 2 years ago

Hey @Jeremy!

Sorry for the epically slow reply - it's a super busy time of year for us!

Anyway, the behavior you're seeing is super weird. But I LOVE what you dove in and found! This is expert-level configuration. Thank you for sharing that!

Cheers!

|

paul-pleavin 2 years ago

Hi, can 'entityClass' be set through yaml resources? After some digging in YamlResourceExtractor I found that we can set 'stateOptions' however this creates ApiPlatform\Metadata\Tests\Fixtures\StateOptions rather then the desired ApiPlatform\State\OptionsInterface\StateOptions.

|

weaverryan SFCASTS paul-pleavin 2 years ago

Hey @Joe-L!

I'm looking at that same class, and I don't think it's possible. There are actually multiple different StateOptions classes based on if you're using the ORM vs elastic search vs other stuff. And it looks like that class was only updated to support the "elastic search" `StateOptions - https://github.com/api-platform/core/blob/main/src/Metadata/Extractor/YamlResourceExtractor.php#L409-L411 - and as you noticed... I'm not sure that this is even the correct class to use in that situation!

So, no I think you're out of luck. I'm guessing there is a way to hook into the "resource metadata system" to add it manually... I may have done something kind of similar in the API Platform version 2 of this tutorial - https://symfonycasts.com/screencast/api-platform2-security/resource-metadata-factory in case that helps. I'm told that some namespaces have changed for doing this in API Platform 3, but nothing super big.

Cheers!

|

Symfony 6.3 API Platform 3

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=8.1",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "api-platform/core": "3.1.x-dev", // 3.1.x-dev
        "doctrine/annotations": "^2.0", // 2.0.1
        "doctrine/doctrine-bundle": "^2.8", // 2.10.2
        "doctrine/doctrine-migrations-bundle": "^3.2", // 3.2.4
        "doctrine/orm": "^2.14", // 2.16.1
        "nelmio/cors-bundle": "^2.2", // 2.3.1
        "nesbot/carbon": "^2.64", // 2.69.0
        "phpdocumentor/reflection-docblock": "^5.3", // 5.3.0
        "phpstan/phpdoc-parser": "^1.15", // 1.23.1
        "symfony/asset": "6.3.*", // v6.3.0
        "symfony/console": "6.3.*", // v6.3.2
        "symfony/dotenv": "6.3.*", // v6.3.0
        "symfony/expression-language": "6.3.*", // v6.3.0
        "symfony/flex": "^2", // v2.3.3
        "symfony/framework-bundle": "6.3.*", // v6.3.2
        "symfony/property-access": "6.3.*", // v6.3.2
        "symfony/property-info": "6.3.*", // v6.3.0
        "symfony/runtime": "6.3.*", // v6.3.2
        "symfony/security-bundle": "6.3.*", // v6.3.3
        "symfony/serializer": "6.3.*", // v6.3.3
        "symfony/stimulus-bundle": "^2.9", // v2.10.0
        "symfony/string": "6.3.*", // v6.3.2
        "symfony/twig-bundle": "6.3.*", // v6.3.0
        "symfony/ux-react": "^2.6", // v2.10.0
        "symfony/ux-vue": "^2.7", // v2.10.0
        "symfony/validator": "6.3.*", // v6.3.2
        "symfony/webpack-encore-bundle": "^2.0", // v2.0.1
        "symfony/yaml": "6.3.*", // v6.3.3
        "symfonycasts/micro-mapper": "^0.1.0" // v0.1.1
    },
    "require-dev": {
        "doctrine/doctrine-fixtures-bundle": "^3.4", // 3.4.4
        "mtdowling/jmespath.php": "^2.6", // 2.6.1
        "phpunit/phpunit": "^9.5", // 9.6.11
        "symfony/browser-kit": "6.3.*", // v6.3.2
        "symfony/css-selector": "6.3.*", // v6.3.2
        "symfony/debug-bundle": "6.3.*", // v6.3.2
        "symfony/maker-bundle": "^1.48", // v1.50.0
        "symfony/monolog-bundle": "^3.0", // v3.8.0
        "symfony/phpunit-bridge": "^6.2", // v6.3.2
        "symfony/stopwatch": "6.3.*", // v6.3.0
        "symfony/web-profiler-bundle": "6.3.*", // v6.3.2
        "zenstruck/browser": "^1.2", // v1.4.0
        "zenstruck/foundry": "^1.26" // v1.35.0
    }
}

Previous Chapter

Next Chapter