Chapters

28 Chapters | 1:45:06 |

01

The REST API Tutorial

3:07
02

HTTP Basics

2:10
03

REST: Resources and Representations

3:12
04

Transitions and Client State

2:11
05

Project Routing

5:22
06

POST: Creation, Location Header and 201

4:53
07

GET’ing Resources, and Content-Type

4:36
08

Updating the Location Header

1:47
09

GET /programmers: A collection of Programmers

3:32
10

Fixing the Content-Type on POST

2:37
11

Testing your API with PHPUnit

2:34
12

Behat for Testing

4:35
13

Handling Data in Tests

3:57
14

PUT: Editing Resources

4:13
15

Debugging Tests

1:12
16

PUT: Killing Duplicated Code

2:12
17

GET Representation != POST Representation

2:46
18

PUT Versus POST

5:07
19

Deleting Resources

2:29
20

PATCH: The Other Edit

4:53
21

Handling Errors

5:41
22

The application/problem+json Content-Type

4:26
23

Enforcing Consistency with ApiProblem

5:13
24

Error in Invalid JSON

4:28
25

ApiProblemException and Exception Handling

5:38
26

Handling 404 Errors

6:17
27

Exposing more Error Details

4:56
28

What’s Next

1:02

This course is archived!

This tutorial uses a deprecated micro-framework called Silex. The fundamentals of REST are still valid, but the code we use can't be used in a real application.

> APIs > RESTful APIs in the Real World Course 1

Buy Access to Course

26.

Handling 404 Errors

|

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

Login or register to check out the script

8 Comments

Sort By

Login or Register to join the conversation

Neandher Carlos 8 years ago edited

Hi. Some fixes:

### ProgrammerController:showAction ###

Current:


$programmer = $this->getProgrammerRepository()->findOneByNickname($nickname);

$data = $this->serializeProgrammer($programmer);

Fix:


$programmer = $this->getProgrammerRepository()->findOneByNickname($nickname);

if (!$programmer) { //
$this->throw404();  //
} //

$data = $this->serializeProgrammer($programmer);

### Application.php ###

Current:


$data = $apiProblem->toArray();

if ($data['type'] != 'about:blank') {
$data['type'] = 'http://localhost:8000/docs/errors#'.$data['type'];
}

$response = new JsonResponse(
$apiProblem->toArray(),
$statusCode
);

Fix:


$data = $apiProblem->toArray();

if ($data['type'] != 'about:blank') {
$data['type'] = 'http://localhost:8000/api/docs/errors#'.$data['type']; // add: api/
}

$response = new JsonResponse(
$data, // <= not $apiProblem->toArray() anymore
$statusCode
);

All green!

:)

|

weaverryan SFCASTS Neandher Carlos 8 years ago

Hey again!

Thanks for the report - but I can't find this. For showAction(), we do throw the 404 error (https://knpuniversity.com/s..., and I don't see it being removed anywhere later. Is there another spot I'm missing?

Cheers!

|

Neandher Carlos weaverryan 8 years ago

You're right, my mistake.

|

weaverryan SFCASTS Neandher Carlos 8 years ago

no worries - you are really good at catching things like this :)

|

Richard Ho 8 years ago edited

Hi, some fixes:

Current:



// src/KnpU/CodeBattle/Application.php
// ...
$data = $apiProblem->toArray();
if ($data['type'] != 'about:blank') {
$data['type'] = 'http://localhost:8000/docs/errors#'.$data['type'];
}
$response = new JsonResponse(
$apiProblem->toArray(),
$statusCode
);

Fix:


// src/KnpU/CodeBattle/Application.php
// ...
$data = $apiProblem->toArray();
if ($data['type'] != 'about:blank') {
    $data['type'] = 'http://localhost:8000/api/docs/errors#'.$data['type'];// "api" in the link
}
$response = new JsonResponse(
    $data,//Instead of $apiProblem->toArray();
    $statusCode
);

|

weaverryan SFCASTS Richard Ho 8 years ago

Thanks so much Richard! I'm deploying these changes right now: https://github.com/knpunive...

Cheers!

|

Florian weaverryan 6 years ago edited

I'm setting the type correctly in the ApiProblem.php constructor.
In my opinion it is a little bit cleaner and all the logic stays in the class


  // src/KnpU/CodeBattle/Controller/Api/ApiProblem.php
  // ..

  public function __construct($statusCode, $type = null)
    {
        $this->statusCode = $statusCode;
        $this->type = $type;

        if (is_null($type)) {
            $this->type = 'about:blank';
            $this->title = (isset(Response::$statusTexts[$statusCode])) ? Response::$statusTexts[$statusCode] : 'Unknown status code :(';
        } else {
            if (!isset(self::$titles[$type])) {
                throw new \Exception(sprintf(
                    'No title for type "%s" found. Did you make  it up?',
                    $type
                ));
            }
            $this->title = self::$titles[$type];
        }

        // fix by sven
        if ($this->type !== 'about:blank') {
            $this->type = 'http://localhost:8000/docs/errors#' . $this->type;
        }
    }

Cheers!

1 |

weaverryan SFCASTS Florian 6 years ago edited

I like it! Thanks for sharing Florian :)

1 |

This tutorial uses a deprecated micro-framework called Silex. The fundamentals of REST are still valid, but the code we use can't be used in a real application.

Silex

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "silex/silex": "~1.0", // v1.3.2
        "symfony/twig-bridge": "~2.1", // v2.7.3
        "symfony/security": "~2.4", // v2.7.3
        "doctrine/dbal": "^2.5.4", // v2.5.4
        "monolog/monolog": "~1.7.0", // 1.7.0
        "symfony/validator": "~2.4", // v2.7.3
        "symfony/expression-language": "~2.4" // v2.7.3
    },
    "require-dev": {
        "behat/mink": "~1.5", // v1.5.0
        "behat/mink-goutte-driver": "~1.0.9", // v1.0.9
        "behat/mink-selenium2-driver": "~1.1.1", // v1.1.1
        "behat/behat": "~2.5", // v2.5.5
        "behat/mink-extension": "~1.2.0", // v1.2.0
        "phpunit/phpunit": "~5.7.0", // 5.7.27
        "guzzle/guzzle": "~3.7" // v3.9.3
    }
}

Previous Chapter

Next Chapter