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

01.

The REST API Tutorial

|

Autoplay

Next Chapter

Login or register to check out the script

11 Comments

Sort By

Login or Register to join the conversation

Yangzhi 2 years ago edited

hi,i learn how to user processor state,but i have one question，for example,i use post to register user.normal will return user entity object. but i use jwt,so when user register,i want return jwt token,mean i want return string.but i got error:

"hydra:description": "ApiPlatform\Symfony\EventListener\WriteListener::getObjectClass(): Argument #1 ($object) must be of type object, string given, called in \/var\/www\/fast\/vendor\/api-platform\/core\/src\/Symfony\/EventListener\/WriteListener.php on line 111",

I kown use custom controller, please tell me is have other best way? thanks

|

weaverryan SFCASTS Yangzhi 2 years ago

Hi @Yangzhi!

On a technical level, when someone does a POST to create a new user, you are "supposed" to return the User resource in the JSON response. But... you can really do whatever you want :P. And you ALMOST have the solution. You must return an object from your processor. So, you could:

A) Create a new class called something like UserJwt with a token property on it
B) Create and return this from your processor

$userJwt = new UserJwt();
$userJwt->token = 'something';

return $userJwt;

So you have the correct idea, but what you return must be an object, which will then be sent through the serializer. If you want the documentation on your endpoint to be correct, you could even set the output: UserJwt::class for that operation.

Cheers!

|

Yangzhi weaverryan 2 years ago edited

so,i created src/Entity/CommonOutput.php, this is only one prop call private mixed $data = null;
in my src/Entity/Company.php,i write:

new Pst(uriTemplate: '/companies/login',output: CommonOutput::class,name:'company.login')

in processor file:

if ($operation->getName() === 'company.login') {
        $token = $this->tokenManager->create($user);
        $output = new CommonOutput();
        $output->setData($token);
        return $output;
 }

i got: hydra:description
:
"Unable to generate an IRI for the item of type \"App\Entity\Company\""

|

weaverryan SFCASTS Yangzhi 2 years ago

Hey @Yangzhi!

Sorry for my slow reply! Hmm. That's interesting that it's trying to generate an IRI... and for Company... what does the stacktrace look like for the error?

Cheers!

|

Yangzhi 2 years ago edited

Hi, some times, i must custom GetCollection operation by own uriTemplate and controller. on own controller my list like this:

public function __invoke(){
      $list=$listRepository->getByOwnCondition();
      $total=$listRepository->getTotalByOwnCondition();
      return $this->json([
            'hydra:member' => $list,
            'hydra:totalItems' => $total
        ], context: ['groups' => 'list']);
}

then the each list object not return '@id'. please do hou have the best way? thanks

|

sadikoff Yangzhi 2 years ago edited

Hey @Yangzhi

This happens because you are returning a response object with everything serialized with default Symfony serializer, try to return a collection of objects $list variable

BTW https://api-platform.com/docs/core/pagination/#custom-controller-action here you can check ApiPlatform example on custom collection with pagination

Cheers!

1 |

Dylan J. 5 years ago

When setting up the code (creating the composer auto loader file) the code works fine, there is a little bit of styling issues, but my main issue is that i cannot choose an avatar therefor i am unable to actually get any further within the program, i've tried to do composer update, after it updates the program is unusable, anyone got any clue?

|

weaverryan SFCASTS Dylan J. 5 years ago

Hey @Dylan!

Yea, the REST fundamentals behind this course are still solid, but the code is OLD. So if you've got styling problems or you can't see the images, my guess is that there may be some minor misconfiguration with your server - all the CSS and images are normal, boring files that sit in the document root (the web directory).

If you open your browser's network tools and refresh, my guess is that you will see errors for the CSS file and image files. Try opening some of those URLs directly in your browser to see what the error is. Is it a 404? An access denied? Something else? And what are the URLs to the assets?

The good news is, I don't think this is a problem with outdated dependencies :).

Cheers!

|

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
    }
}

Next Chapter