JSON API Endpoint

Decided to have a look at the example url for the JSON endpoint...

I'm not even mad

I'm glad you did :D

Same here

I am getting the Json response like this:
{"id":"5","name":"Waterfalls","url":"https:\/\/symfonycasts.s3.amazonaws.com\/sample.mp3"}

Even when I copy and paste entire controller, it doesn't change

Hey @Artun!

Actually, that looks perfect to me! It looks a bit different than what you see in the video because I have a browser plugin that makes it look fancy (my bad - I should have mentioned that). In JSON, having quotes around the keys = like "id" is correct. In the video, that browser plugin is hiding those quotes to make it look prettier. But your response is exactly what we want :).

Cheers!

Hey @weaverryan!
Thanks for your reply.So I am assuming the backslaches in the url is also expected? instead of "https://symfonycasts.s3.amazonaws.com/sample.mp3"
it shows as
"https:\/\/symfonycasts.s3.amazonaws.com\/sample.mp3"

Yes @Artun, the "JSON encode" function takes care of escaping any reserved character, for example, if you have double quotes in your data, those will be escaped too

Cheers!

This lesson did not work for me as instructed. I needed to add the following in order for it to work.

use Symfony\Component\HttpFoundation\JsonResponse;

Thank you once again, I just fixed the code block in the script. Cheers!

good Tutorials, I come from Laravel and everything make sense its more lighter then laravel or lumen but when I saw you how you created Controller file I thought there should be easier way something like command "php artisan make:controller" to do, what I found there is "php bin/console make:crontroller" it requires "maker" you should show this too it makes your life easier

Hey Engazan,

Actually, there's an easier way for controller, you need to have Maker bundle installed and then as you said you can call:

bin/console make:controller

To be able to use the Maker bundle (if you don't have one) - first, you need to execute:

composer require maker

We wanted to show the strightforawrd way focusing the attention on no magic, you just need to create a simple PHP class in the specific folder. We will show the way with Maker in future tutorials too. ;)

Cheers!

Hi again, Ryan.

I just ran into another issue, and this time I made sure that the code in my controller doesn't miss anything.

It looks like my Symfony is somehow ignoring the fact that I created a brand-new route, because upon trying to open it in the browser, the framework is throwing a 404 Exception: No route found for "GET https://127.0.0.1:8000/api/songs/5".

Moreover, by issuing the bin/console debug:router command, the new route isn't showing up. Clearing up the caches and restarting the server didn't make any difference either.

Here's my SongController code:

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class SongController extends AbstractController
{
    #[Route('/api/songs/{id}')]

    public function getSong($id): Response
    {
        dd($id);
    }

What's happening? Any ideas?

Thank you so much.

Hey @roenfeldt!

Hmm.

Moreover, by issuing the bin/console debug:router command, the new route isn't showing up

That was a great thing to try for debugging. And while you shouldn't need to clear the cache ever, when you hit a super weird issue it's always a good thing to try as well. So nice job there.

So, why isn't this working? First, remove that line break between the #[Route] and the public function. I don't think that's the issue (I had never tried it before, but having a line break doesn't seem to cause any issues) - but better to remove it. To other things to check, which will sound crazy, but there is very little else that could be going wrong: (A) make sure you have the <?php at the start of your file (I have seen this many times and it's super hard to debug) and (B) triple-check that you're inside of the src/Controller/ directory.

The mechanism for loading these attribute routes is pretty simple: in your config/routes.yaml directory, there is a line there that says

look at all php files in src/Controller and parse their #[Route] attributes.

It's these 3 lines - https://github.com/symfony/recipes/blob/main/symfony/routing/6.1/config/routes.yaml#L1-L3 . So, there's not a lot that can go wrong as long as you have a valid php file in the src/Controller/ directory (and the contents of your class - apart from the potential missing <?php look perfect).

Let me know if any of this helps :).

Cheers!

Hi Ryan,

First off, thank you for the fast reply, and thank you for the very nice explanation!

With the help of your suggestions, I realized that PhpStorm created the file into the wrong folder. My SongController was created inside src/App/Controller. How did that happen? Well, the error was, once again, on the exterior of the screen, of course :)

Because I learned my lesson from the previous time (the Controller's namespace was missing the App\ part), in order to prevent that from happening again, I used PhpStorm's New > PHP Class dialog (just like you did in the video), but as an extra step, I updated the Namespace field by prepending App\ to the existing Controller value. And then I pressed Return, of course without realizing that PhpStorm will create the wrongful folder structure based on what I chose in there.

If I didn't do that, the path for the new Controller would have been correct, but then the namespace inside it would have caused Symfony to throw the Controller (...) has no container set, did you forget to define it as a service subscriber? 500 Exception.

To conclude, your suggestions put me back on track, for which I am grateful. But my question now is, how would you suggest I'd handle this problem, because I need PhpStorm to automatically prepend App\ to the namespace of any new Controller I'd be creating, just like it does in your video?

Thank you so much, Ryan! :)

Hey @roenfeldt!

Yea, the "New -> PHP Class" dialog is great - and it is definitely NOT working correctly for you. In order for that to work, PhpStorm needs to know which namespace lives in which directory. In a Symfony app, the App\ namespace lives in src. This convention isn't hardcoded into Symfony - it's actually a setting in your composer.json file: https://github.com/symfony/skeleton/blob/948939fb8ac6b1ab38547bff6f386bca3a782ed4/composer.json#L35-L39

For the last 2-ish years, PHPStorm should automatically read this setting and use that when you create classes. For some reason that's not happening, or it's reading it incorrectly. Or, that feature just isn't activated for some reason. Go into your PHPStorm settings. Inside, go to PHP -> Composer and look for a check box that says Synchronize IDE Settings with composer.json - I believe this needs to be activated.

Let me know if that helps :).

Cheers!

Hey Ryan,

Enabling the Synchronize IDE Settings with composer.jsoncheckbox did the trick. Yay! :D

Thank you for clarifying this out for me!

Cheers! :)