Instalación de la API Platform

Hey @gilbertodiaz ,

You're probably missing some packages. Could you try to install API platform as it's shown in this course? The Flex recipe installs this API pack: https://github.com/api-platform/api-pack - you may want to try to install missing packages manually from that pack to see if that helps, otherwise, try to remove it and install the full package at once that will also may execute some recipes.

I hope this helps!

Cheers!

composer require api is no longer official install for using API Platform 4
You need to use composer require api-platform/core package

There is some confusions between first page website API Platform and their documentation.

If you want to follow this course I think you need to force install of previous package version than 'api' recipe.
Because follow official process of THIS COURSE at THIS TIME no longer run correctly.

I try lot of think in any direction and nothing run.
I just use 'composer require api-platform/core' in empty Symfony project and all well-done like a charm.

If this can help everyone...

I did find an issue with composer require api when following along with the code provided by this course. A new phpstan/phpdoc-parser 2.0 was being installed but the api-platform version used in this course (3.2) didn't support it.

I've fixed this problem so it now should install without issue.

composer require api is no longer official install for using API Platform 4

Hey @neostar! Could you show where you are seeing this? All the official docs show composer require api but I see you mention this may not be correct.

just one the first page of api platform ;) https://api-platform.com/
"the easiest way to create your web API"

Thanks man, I was going crazy, I've been working for two hours with the composer require api and I couldn't figure out what was wrong.

The current asset mapper recipe includes: "missing_import_mode: strict" in all environments except production. Change it to:

# config/packages/asset_mapper.yaml
framework:
    asset_mapper:
        # The paths to make available to the asset mapper.
        paths:
            - assets/
        missing_import_mode: warn

Sorry, i made a mistake in installation command, the correct is symfony composer require api-platform/api-pack

I'm glad to hear you could fix your problem. Cheers!

Please could you look at my issue? Thank you very much!

Let's try to debug it. Does anything change if you compile the assets? symfony console asset-map:compile
Did you also install api-platform/graphql? If that's the case but you don't need it try removing it or start by disabling it

# api/config/packages/api_platform.yaml
api_platform:
  graphql:
    graphiql:
      enabled: false

Hello,

thank you for reply!

Actually its impossible to run symfony console asset-map:compile, because this fails:

✗ symfony console asset-map:compile
Warming the icon cache...
Icon cache warmed.

 // Compiling and writing asset files to public                
In JavaScriptImportPathCompiler.php line 145:
Unable to find asset "./path/to/domAnimations" imported from "/Users/path/to/project/vendor/api-platform/symfony/Bundle/Resources/pu  
  blic/graphiql/graphiql.min.js".                                                                 
asset-map:compile

About package api-platform/graphql - I dont install it and i check, i dont have it installed also.

Thank you for help!

No, the problem is not fixed, I was only correcting mistake from my first post.

If you run composer why api-platform/graphql does it say "package not found"? Can you double-check the paths of your resources, I find them a bit weird ./path/to/domAnimations and /Users/path/to/project/vendor/apiplatform/symfony/Bundle/Resources/public/graphiql/graphiql.min.js

Thank you for reply!

When I run symfony composer why api-platform/graphql

I got this error

In BaseDependencyCommand.php line 103:
                                                                 
  Could not find package "api-platform/graphql" in your project  
                                                                 

depends [-r|--recursive] [-t|--tree] [--locked] [--] <package>

unable to run /opt/homebrew/bin/composer why api-platform/graphql

When I check the directory ls vendor/api-platform/symfony/Bundle/Resources/public/graphiql

I got this two files there:

graphiql.css    graphiql.min.js

And finally, when I inspect this file graphiql.min.js

I found this commented block:

STARTING FROM LINE 37789...
 * // Asynchronous loading
 * import { LazyMotion, m } from "framer-motion"
 *
 * function App() {
 *   return (
 *     <LazyMotion features={() => import('./path/to/domAnimations')}>
 *       <m.div animate={{ scale: 2 }} />
 *     </LazyMotion>
 *   )
 * }

This is probably bug, because this import('./path/to/domAnimations') is in commented block of code.

I dont know how to solve this issue.

Regardsw Tomas

Ok, so your entire Symfony app is broken due to that strange error. Run the composer command without using Symfony composer why api-platform/graphql. Also, try re-installing your vendor directory, I'm not sure what's causing that error so I'd like to double-check that everything is installed/configured correctly.

Hello,

When i run composer why api-platform/graphql without symfony, I got still this error

composer why api-platform/graphql

In BaseDependencyCommand.php line 103:
                                                                 
  Could not find package "api-platform/graphql" in your project  
                                                                 

depends [-r|--recursive] [-t|--tree] [--locked] [--] <package>

I try to delete entire content of the vendor directory and re-run composer install

After that i try to run composer why api-platform/graphql, but the output is the same as before.

There is my composer.json

{
    "type": "project",
    "license": "proprietary",
    "minimum-stability": "stable",
    "prefer-stable": true,
    "require": {
        "php": ">=8.4",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "api-platform/doctrine-orm": "^4.0",
        "api-platform/symfony": "^4.0",
        "doctrine/dbal": "^3",
        "doctrine/doctrine-bundle": "^2.13",
        "doctrine/doctrine-fixtures-bundle": "^3.6",
        "doctrine/doctrine-migrations-bundle": "^3.3",
        "doctrine/orm": "^3.3",
        "infinite-networks/form-bundle": "^3.5",
        "knplabs/knp-menu-bundle": "^3.5",
        "nelmio/cors-bundle": "^2.5",
        "onelogin/php-saml": "^4.2",
        "phpdocumentor/reflection-docblock": "^5.5",
        "phpstan/phpdoc-parser": "^1.33",
        "symfony/asset": "7.2.*",
        "symfony/asset-mapper": "7.2.*",
        "symfony/console": "7.2.*",
        "symfony/doctrine-messenger": "7.2.*",
        "symfony/dotenv": "7.2.*",
        "symfony/expression-language": "7.2.*",
        "symfony/flex": "^2",
        "symfony/form": "7.2.*",
        "symfony/framework-bundle": "7.2.*",
        "symfony/http-client": "7.2.*",
        "symfony/intl": "7.2.*",
        "symfony/mailer": "7.2.*",
        "symfony/mime": "7.2.*",
        "symfony/monolog-bundle": "^3.0",
        "symfony/notifier": "7.2.*",
        "symfony/process": "7.2.*",
        "symfony/property-access": "7.2.*",
        "symfony/property-info": "7.2.*",
        "symfony/runtime": "7.2.*",
        "symfony/security-bundle": "7.2.*",
        "symfony/serializer": "7.2.*",
        "symfony/stimulus-bundle": "^2.21",
        "symfony/string": "7.2.*",
        "symfony/translation": "7.2.*",
        "symfony/twig-bundle": "7.2.*",
        "symfony/uid": "7.2.*",
        "symfony/ux-autocomplete": "^2.23",
        "symfony/ux-icons": "^2.21",
        "symfony/ux-turbo": "^2.21",
        "symfony/validator": "7.2.*",
        "symfony/web-link": "7.2.*",
        "symfony/yaml": "7.2.*",
        "twig/extra-bundle": "^2.12|^3.0",
        "twig/twig": "^2.12|^3.0"
    },
    "config": {
        "allow-plugins": {
            "php-http/discovery": true,
            "symfony/flex": true,
            "symfony/runtime": true
        },
        "sort-packages": true
    },
    "autoload": {
        "psr-4": {
            "App\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "App\\Tests\\": "tests/"
        }
    },
    "replace": {
        "symfony/polyfill-ctype": "*",
        "symfony/polyfill-iconv": "*",
        "symfony/polyfill-php72": "*",
        "symfony/polyfill-php73": "*",
        "symfony/polyfill-php74": "*",
        "symfony/polyfill-php80": "*",
        "symfony/polyfill-php81": "*",
        "symfony/polyfill-php82": "*",
        "symfony/polyfill-php83": "*",
        "symfony/polyfill-php84": "*"
    },
    "scripts": {
        "auto-scripts": {
            "cache:clear": "symfony-cmd",
            "assets:install %PUBLIC_DIR%": "symfony-cmd",
            "importmap:install": "symfony-cmd"
        },
        "post-install-cmd": [
            "@auto-scripts"
        ],
        "post-update-cmd": [
            "@auto-scripts"
        ]
    },
    "conflict": {
        "symfony/symfony": "*"
    },
    "extra": {
        "symfony": {
            "allow-contrib": false,
            "require": "7.2.*",
            "docker": true
        }
    },
    "require-dev": {
        "phpunit/phpunit": "^9.5",
        "symfony/browser-kit": "7.2.*",
        "symfony/css-selector": "7.2.*",
        "symfony/debug-bundle": "7.2.*",
        "symfony/maker-bundle": "^1.61",
        "symfony/phpunit-bridge": "^7.2",
        "symfony/stopwatch": "7.2.*",
        "symfony/web-profiler-bundle": "7.2.*"
    }
}

Thank you @MolloKhan for help, i hope we will manage it soon :-)

Thank you!

Interesting, inside your composer.lock file search for api-platform/graphql if you find it, delete the lock file and re-install your vendors.
If that's not the case, execute at the root of your project `git grep "graphql" just to see if we can find a lead to the problem (your code needs to be committed first)
If nothing works, I'm afraid I'll need to check your project, this issue is going too far 😅

Hello,

I did the following steps:

1. Remove vendor folder
2. Remove composer.lock file
3. Run composer install

The problem still persists.

I try your TIP and run

git grep "graphql"
composer.lock:                "api-platform/graphql": "For GraphQl mercure subscriptions.",
composer.lock:                "graphql",
composer.lock:                "graphql",
composer.lock:                "graphql",
composer.lock:                "graphql",
composer.lock:                "graphql",
composer.lock:                "graphql",
composer.lock:                "graphql",
composer.lock:                "graphql",
composer.lock:                "api-platform/graphql": "^4.1",
composer.lock:                "webonyx/graphql-php": "^15.0"
composer.lock:                "api-platform/graphql": "To support GraphQL.",
composer.lock:                "graphql",
composer.lock:                "graphql",

I think there must be bug somewhere.

Should I put the sources of my project intto github?

Thank you!

Ohh, so there's a dependency using the api-platform/graphql library. The problem is we can't know which one it is because composer why is not working. The only idea that comes to mind (for the moment) is to manually remove each dependency that you added before having this problem.
Yea, uploading your project to GitHub may help me spot the problem. The only problem is I'll be off for a week (I'm attending the Symfony Chicago conference). I hope you can find a solution before that, if not I'll come back to help you out.

Cheers!

I have the same problem :(

Sorry for my late reply. Did you manage to find the problem? I'm kinda out of options here. You could try asking for help in the Symfony Slack channel, there's a ApiPlatform channel

Try composer update - it worked for me.

I've updated symfony/dependency-injection in the code download to fix this. Thanks for the head's up!

Hey Elijah,

We talked about running Symfony projects with Docker in e.g. this course: https://symfonycasts.com/screencast/symfony-doctrine - you can download the course code and pull some Docker-related files from the finish/ directory of it. Also, I would recommend you to watch a few first videos from that course to see how we work with it: https://symfonycasts.com/screencast/symfony-doctrine/install

I bet it will help you a lot :)

Cheers!

Thx a lot!

Hey @RB_87

I'm afraid it's not compatible. In their composer.json I see they require Symfony 6 components https://github.com/api-platform/core/blob/main/composer.json
But, I may be wrong, the best way to know is by giving it a try :)

Cheers!

Hey @iclaborda ,

What exactly steps? What commands did you run? composer require api? Please, make sure the recipe was executed in your console, usually Composer will ask you if you want to install the recipe and you should reply "Yes". Otherwise no config files will be created, and so it won't work our of the box unless you put all the config files yourself.

I'd recommend you to do composer remove api and then again: composer require api - but watch closer what Composer asks you - you will need to confirm installing the recipe, and also double check that you have all those config files after that we have in the video.

P.s. Also please, try to clear the cache just in case :)

Cheers!

Hey @ties8

In our recent ApiPlatform 3 tutorial we do not talk too much about customizing the docs but I think this video may help you out https://symfonycasts.com/screencast/api-platform-security/open-api-decoration
You can also check the ApiPlatform docs

Cheers!

I am not sure if we are on the same page about what can be done with the Resource Metadata Factory in 2.6. Perhaps i should explain a bit further.
As far as i understood it, the Resource Metadata Factory generates the default values for what can then be modified inside the #[ApiResource] attribute set on every class.
So in 2.6 by decorating the Resource Metadata Factory i could once, dynamically, change the options which would normally be statically defined in every class inside the #[ApiResource] attribute. In your course "API Platform 2 Chapter 27" the system is used to dynamically set the normalization context instead of having to define it statically in the API Platform attribute on every class.
You can modify the CollectionOperations, ItemOperations, SubresourceOperations and other Attributes of the resource.
In my example of a inheritance structure i would have to define an #[ApiResource(...)] with the same content: short name, security ect. on every class which inherits from "Cheese". With a Resource Metadata Factory i avoid having to do that 3 times but can centralize it. The decorated Resource Metadata Factory checks if the resource it generates the metadata for is inheriting "Cheese" and then adjusts the data it generates accordingly.

I hope its now clear what i used the Metadata Factory for, if there is a video already available or in planning on how the stuff the Decorated Metadata Factory did is now done i would appreciate it if you could let me know.

Hey @ties8!

Yup, I know what you're talking about :). The short answer is that no, unfortunately, I decided not to cover this for the API Platform 3 tutorial. I just wasn't sure how many people were actually using it. But I can also say that, afaik, there is nothing that makes this now a "bad idea" in API Platform 3. The approach just needs to be updated for the config system. I can't say how to do it, as I haven't tried it. However, I don't think that the solution would be all that different. API Platform 3 still has this concept of "resource metadata collection factories" - here's the interface https://github.com/api-platform/core/blob/main/src/Metadata/Resource/Factory/ResourceMetadataCollectionFactoryInterface.php - and there are a bunch of them that use decoration to add more data. And you'll notice that interface looks identical to what we did in API Platform 2. So, this may just be a matter of adjusting your old interfaces and a few minor tweaks.

Btw, if you're successful (or not), I'd love to know!

Cheers!

Starting my migration i found using "DoctrineOrmResourceCollectionMetadataFactory" was a good way to start. So far it seems to work, although i have not yet migrated my tests to v3.
As for using the Metadata Factory, first i use it for inheritance, one Metadata Factory sets all metadata for every child Resource and second for mass applying security to a part of an app. For example if i have 5 Resources only accessible to Premium Subscribers i can create and apply a "PremiumSubscriberResourceInterface" to all five of them and handle security centralized inside the Metadata Factory.

Woo! Sounds promising. And your use-case makes a lot of sense. This is one of those features where it feels like they probably shouldn't add something so automatic to the core of API Platform... but for certain projects, users can really leverage it.

Good luck!

Hey there,

I believe you're missing a few required packages that are absent from the symfony/skeleton project. Try creating a new project but installing symfony/webapp-pack

Cheers!

Thanks for the tip... That helped, but still had a problem, which in the end turned out to be a needed ".htaccess" file in the "public" folder (Running XAMPP on Windows) so it would perform the needed mod-rewrite rules forcing routes like /api to be directed into the index.php file instead of directly to apache (which of course could not find a /api folder under the public folder

Ohh, you're using XAMPP, I assumed you were using Symfony's web server. It does what you said under the hood :)

Hey Michal!

Hmm. The problem is that API Platform 3 requires Symfony 6. So if you're using API Platform with Symfony 5, then I think you're using version 2.7, not 3. However, 2.7 and 3.0 are identical, except that deprecated items have been removed in 3.0. And, if you're using 2.7, you should set the metadata_backward_compatibility_layer flag to false - ref https://api-platform.com/docs/core/upgrade-guide/#im-migrating-from-26-and-want-to-prepare-for-30

If you do that, then yes, I think we very few exceptions, the tutorial will work fine for Symfony 5 and API Platform 2.7. If you hit any snags, you can let us know and we'll do our best to help!

Cheers!

Hey Vishajr,

The more you watch - the more you know ;) So, feel free to jump into ApiPlatform v2 tutorials first if you need it now, because releasing same tutorials on v3 will take some time. So it makes sense to start from those tutorials that are already recorded if you don't want to simply wait for new ones. But later, when v3 tutorials will be released - you can watch it again and I bet you will discover more new things for yourself, or even better understand it because you will have some base after old tutorials :)

Also, we added some notes in our v2 tutorials mentioning some differences and BC breaks, so it should help you as well ;)

Cheers!

Hi kyotomano!

This is a perfect time to ask these questions :).

Is this course going to be divided into 3 parts just like api platform 2? [base, security, custom resources].

Probably, yes. Though there are a few things that I need to look into - like much better support in API Platform 3 for DTO objects - that might affect exactly what's in each episode or how we split it all up.

Are you going to cover Mercure?

I wasn't planning on it... at least not in any big way. But is that something you're interested with in regards to API Platform? What are you hoping to use it for?

When are you going to release all 3 parts (I read comment from SC team member who claimed that it would be released by the end of the year, but it was 3 months ago)? Btw. Great pick. V3 seems to be much different than V2

Yea :/. The conference and holidays slowed things down. I don't know when... but I'm really hoping to dive through all 3 as quickly as possible vs ep 1, a break, ep2, a break, ep 3, which I know is annoying for everyone.

If there are some specific things that you'd like to see in the more advanced tutorials, now is a great time to let me know!

Cheers!