Chapters

14 Chapters | 54:08 |

01

Validation Errors Test

3:46
02

Sending back Validation Errors

5:13
03

PUT Validation and CSRF Tokens

2:56
04

99 api/problem+json(s)

3:21
05

Modeling the Error: ApiProblem Class

2:41
06

Keeping Problem types Consistent

2:32
07

The All-Important HttpExceptionInterface

4:44
08

Creating the Invalid JSON ApiProblem, and then...

1:49
09

ApiProblemException

3:18
10

Request Format: Why Exceptions Return HTML

1:33
11

Global RESTful Exception Handling

6:55
12

Handling 404's + other Errors

6:25
13

The Helpful Detail Key

3:19
14

Debugging and Cleanup

5:36

This tutorial has a new version, check it out!

> APIs > Symfony RESTful API: Errors (Course 2)

Buy Access to Course

11.

Global RESTful Exception Handling

|

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 $10.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

8 Comments

Sort By

Login or Register to join the conversation

Skylar 8 years ago edited

YAGT! Yet Another Great Tutorial.

So I am using these concepts in Symfony 4, and one of the great new features is the automatic lookup for an entity when you type hint the controller method with the Entity Class like this:


 /**
   * @Route("/api/veconfig/{VEConfigUID}", name="getVEConfig", methods={"GET"})
   */
  public function getVEConfigAction(VEConfig $VEConfig)
  {
    if (!$VEConfig) {
      $this->throwApiProblemVEConfigNotFoundException($VEConfig->getVEConfigUID());
    }
    return new JsonResponse($this->serialize($VEConfig), 200, [], true);
  }

The problem is that the @ParamConverter catches the error first. That is not so bad, but I wanted the message to better than "App\Entity\VEConfig object not found by the @ParamConverter annotation."

Something like "Your VE Configuration could not be found. VEConfigUID = %s", $VEConfigUID

The only thing I could think of was to hack the apiExceptionSubscriber, and intercept the message, but that was not clean. Any Ideas?

|

Mouad E. Skylar 6 years ago edited

Hi Skylar after 2 years is it still unable to custom the exception thrown by ParamConverter(NotFoundHttpException) in a clean way?

|

sadikoff Mouad E. 6 years ago edited

Hey Mouad E.

I guess it's not a problem that I'm not Ryan))) But I'll try to answer your question! Unfortunately there is still no way to modify default exception, so Ryan's answer is still relevant, you can make your argument optional, and then check it and throw exception manually. And I think there is a hard way))) create your own ParamConverter if you need it to be more reusable.

Cheers!

|

weaverryan SFCASTS Skylar 8 years ago edited

Hey Skylar!

Hmm, yes, indeed! The ParamConverter only gives you that generic message... which is normally fine (in an HTML website where you don't show any error)... but I see what you're trying to do! And yea... there's no clean way to do this: the exception thrown by ParamConverter is a generic NotFoundHttpException. So, apart from parsing the string of the message, there's no way for you to cleanly "catch" that the 404 is caused by the ParamConverter. The only solution I can think of is to make your argument optional VEConfig $VEConfig = null. I believe this will cause the ParamConverter to NOT 404, and then your if statement will work as you expect.

I hope that idea helps :).

Cheers!

|

DevDonkey 8 years ago

the amount of time Ive revisited this course is amazing.

[Possibly bad idea] You have so much really cool stuff knocking about for testing API's, I wonder if its worth making a KNP ApiTestingBundle? I find myself copying this stuff around so much into side projects.. I bet others do too.

|

weaverryan SFCASTS DevDonkey 8 years ago

Yea, I've thought about that too - I'll add it to my open source list - I think it might be nice (and would let the community add more ideas to it).

Cheers!

|

DevDonkey weaverryan 8 years ago

I for one would be happy to contribute as much as I could.

|

Mike Ritter 8 years ago

"message will self destruct"

-1 |

This tutorial uses an older version of Symfony. The concepts of REST and errors are still valid, but I recommend using API Platform in new Symfony apps.

Symfony 3

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=5.3.3",
        "symfony/symfony": "2.6.*", // v2.6.11
        "doctrine/orm": "~2.2,>=2.2.3,<2.5", // v2.4.7
        "doctrine/dbal": "<2.5", // v2.4.4
        "doctrine/doctrine-bundle": "~1.2", // v1.4.0
        "twig/extensions": "~1.0", // v1.2.0
        "symfony/assetic-bundle": "~2.3", // v2.6.1
        "symfony/swiftmailer-bundle": "~2.3", // v2.3.8
        "symfony/monolog-bundle": "~2.4", // v2.7.1
        "sensio/distribution-bundle": "~3.0,>=3.0.12", // v3.0.21
        "sensio/framework-extra-bundle": "~3.0,>=3.0.2", // v3.0.7
        "incenteev/composer-parameter-handler": "~2.0", // v2.1.0
        "hautelook/alice-bundle": "0.2.*", // 0.2
        "jms/serializer-bundle": "0.13.*" // 0.13.0
    },
    "require-dev": {
        "sensio/generator-bundle": "~2.3", // v2.5.3
        "behat/behat": "~3.0", // v3.0.15
        "behat/mink-extension": "~2.0.1", // v2.0.1
        "behat/mink-goutte-driver": "~1.1.0", // v1.1.0
        "behat/mink-selenium2-driver": "~1.2.0", // v1.2.0
        "phpunit/phpunit": "~4.6.0" // 4.6.4
    }
}

Previous Chapter

Next Chapter