Chapters

20 Chapters | 1:18:30 |

01

The Battle Resource

2:54
02

Designing (Testing) the Create Battle Endpoint

3:56
03

Saving Related Resources in a Form

4:44
04

Finishing the Battle

2:47
05

VirtualProperty: Add Crazy JSON Fields

4:50
06

Form Voodoo: property_path

2:26
07

Adding Battle Validation

3:28
08

EntityType Validation: Restrict Invalid programmerId

5:16
09

HATEOAS & Hypermedia: The Buzzwords Level

4:19
10

Link from Battle to Programmer

2:34
11

The Great Hateoas PHP Library

3:17
12

The HAL JSON Standard

3:53
13

Embedding Objects with Hal?

2:26
14

Customize how your Links Render

4:50
15

Customizing (making less ugly) Embeddeds!

3:44
16

Subordinate URL Structure

3:22
17

Coding the Subordinate Resource Endpoint

3:57
18

Rock-Solid, Consistent Collection Endpoints

4:10
19

Weird Endpoint: The tagline as a Resource?

5:47
20

Weird Endpoint: Command: Power-Up a Programmer

5:50

This tutorial has a new version, check it out!

> APIs > Symfony RESTful API: Hypermedia, Links & Bonuses (Course 5)

Buy Access to Course

20.

Weird Endpoint: Command: Power-Up a Programmer

|

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

Browse Tutorials

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

14 Comments

Sort By

Login or Register to join the conversation

Lijana Z. 7 years ago

REST for me felt always like waste of time thinking about correct urls, status codes. As you showed also - there are situations where it does not fit in REST rules anyway. I remember long time ago I was using only GET and POST and whatever url felt good for me. And it was enough. No http codes. And I had no problems.

|

weaverryan SFCASTS Lijana Z. 7 years ago edited

Hey Lijana Z.!

I think knowing what the "rules" are can help us normalize our APIs and make them all "work" a little more consistently. But yea, you can take this to an extreme - and that's exactly what I want people to not worry about. Not sure what the correct status code or HTTP verb is for an endpoint? Spend 5 seconds thinking about it, then choose your first choice and move on ;).

So, we're thinking alike!

Cheers!

|

Vladimir Z. 8 years ago

Will there be a REST Course 6?

|

weaverryan SFCASTS Vladimir Z. 8 years ago

Right now, no - I don't see enough topics that we still haven't covered. But, if you have some topics that are still troubling you, then you're probably not the only one, and there might be a course 6 :)

|

weaverryan SFCASTS weaverryan 8 years ago

Oh, except that we *may* do a course on documentation - that is one topic that we haven't covered yet.

|

Johan 8 years ago

The only problem I'm having with all this code right now is that I can't change the URL structure. If I wanted to use singular resource names, so "api/programmer" instead of "api/programmers" I'd be in trouble... I'd have to change all the tests and all the annotations in the controllers :(

|

Victor SFCASTS Johan 8 years ago

Hey Johan,

But it's a good practice to hardcode URLs in tests. It's a bad idea to use router to generate URLs in tests. Imagine, you've accidentally changed some URL - then some tests will fail and show you the problem. of course you can move duplicated URL prefix in a private property, but probably it just worse test readability: tests should be well readable. And btw, URLs change very rare, i'd say API URLs never change ;)

Cheers!

|

Johan Victor 8 years ago

Ye you're right. I checked the symfony docs and they say the same thing. Thanks :)

But what about we put @Route("/api/programmers") as a class annotation in the ProgrammerController and create routes relative to that route instead? I think it would be good :)

Thanks Victor

|

Victor SFCASTS Johan 8 years ago

Yeah, I'm definitely +1 for it! We always try to do that if it possible - it reduces misprints. But here we left it as is to reduce complexity and do not produce questions: some parts of the class is hidden due to our dynamic code blocks.

Cheers!

1 |

Johan Victor 8 years ago

That makes sense, thanks! :)

|

Neandher Carlos 8 years ago edited

I need help to upload.

$request->getContent()```


With PUT and PATCH:

------WebKitFormBoundaryUFCyBVhvYZjTos7t
Content-Disposition: form-data; name="avatarImageFile"; filename="cadastro_consultas.jpg"
Content-Type: image/jpeg

��JFIFHH��ExifMM*bj

....



With POST:

object(Symfony\Component\HttpFoundation\File\UploadedFile)[15]
private 'test' => boolean false
private 'originalName' => string 'cadastro_membros.jpg' (length=20)
private 'mimeType' => string 'image/jpeg' (length=10)
private 'size' => int 276654
private 'error' => int 0
private 'pathName' (SplFileInfo) => string 'C:\Windows\Temp\phpD540.tmp' (length=27)
private 'fileName' (SplFileInfo) => string 'phpD540.tmp' (length=11)`

In update resource with files to upload, showld i use POST instead PUT or PATCH????

|

Victor SFCASTS Neandher Carlos 8 years ago

Hey Carlos,

If you'd like to use PUT / PATCH methods, then you have to put the file's content in the body of your request I think, otherwise use POST to upload files. Here's a bit more details on how to upload a file using PUT: http://php.net/manual/en/fe...

Cheers!

|

Till 8 years ago

Hi, thanks for this course. Shouldn't in real life the ProgrammerController->newAction better be available for anonymous? I you change this only by annotations. You get stuck with $this->getUser() which can't be used anonymously.

|

Victor SFCASTS Till 8 years ago

Hey Till,

Yes, the "ProgrammerController::newAction()" shouldn't be available for anonymous users, otherwise we will have a problem, since in "Programmer::setUser()" has the "public function setUser(User $user)" signature, i.e. we don't allow passing null here. However, "@Security("is_granted('ROLE_USER')")" annotation for the "ProgrammerController" class ensure that we always has a user in this controller, so if user is null - you can't get these end points.

Cheers!

|

This tutorial uses an older version of Symfony. The concepts of Hypermedia & HATEOAS are still valid. But I recommend using API Platform in modern Symfony apps.

Symfony 3

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=5.5.9",
        "symfony/symfony": "3.0.*", // v3.0.3
        "doctrine/orm": "^2.5", // v2.5.4
        "doctrine/doctrine-bundle": "^1.6", // 1.6.2
        "doctrine/doctrine-cache-bundle": "^1.2", // 1.3.0
        "symfony/swiftmailer-bundle": "^2.3", // v2.3.11
        "symfony/monolog-bundle": "^2.8", // v2.10.0
        "sensio/distribution-bundle": "^5.0", // v5.0.4
        "sensio/framework-extra-bundle": "^3.0.2", // v3.0.14
        "incenteev/composer-parameter-handler": "~2.0", // v2.1.2
        "jms/serializer-bundle": "^1.1.0", // 1.1.0
        "white-october/pagerfanta-bundle": "^1.0", // v1.0.5
        "lexik/jwt-authentication-bundle": "^1.4", // v1.4.3
        "willdurand/hateoas-bundle": "^1.1" // 1.1.1
    },
    "require-dev": {
        "sensio/generator-bundle": "^3.0", // v3.0.6
        "symfony/phpunit-bridge": "^3.0", // v3.0.3
        "behat/behat": "~3.1@dev", // dev-master
        "behat/mink-extension": "~2.2.0", // v2.2
        "behat/mink-goutte-driver": "~1.2.0", // v1.2.1
        "behat/mink-selenium2-driver": "~1.3.0", // v1.3.1
        "phpunit/phpunit": "~4.6.0", // 4.6.10
        "doctrine/doctrine-fixtures-bundle": "^2.3" // 2.3.0
    }
}

Previous Chapter

Browse Tutorials