Chapters

28 Chapters | 2:51:42 |

01

Installing API Platform

7:29
02

Creating your First ApiResource

5:44
03

Swagger UI: Interactive Docs

6:41
04

The Powerful OpenAPI Spec

5:24
05

JSON-LD: Giving Meaning to your Data

7:21
06

Hydra: Describing API Classes, Operations & More

4:06
07

API Debugging with the Profiler

5:12
08

Operations / Endpoints

6:38
09

The Serializer

9:08
10

Serialization Groups: Choosing Fields

7:28
11

Serialization Tricks

5:15
12

Pagination & Foundry Fixtures

5:44
13

Filters: Searching Results

5:14
14

PropertyFilter: Sparse Fieldsets

6:55
15

More Formats: HAL & CSV

7:10
16

Validation

5:29
17

Creating a User Entity

4:06
18

User API Resource

5:51
19

Relating Resources

7:08
20

Relations & Iris

3:40
21

Embedded Relations

5:58
22

Embedded Write

7:29
23

Adding Items to a Collection Property

4:04
24

Creating Embedded Objects

5:34
25

Removing Items from a Collection

3:49
26

Filtering on Relations

3:51
27

Subresources

9:54
28

React Admin

9:20

> APIs > API Platform 3 Part 1: Mythically Good RESTful APIs

Buy Access to Course

04.

The Powerful OpenAPI Spec

|

|

Autoplay

Previous Chapter

Next Chapter

Login or register to check out the script

5 Comments

Sort By

Login or Register to join the conversation

opalint 2 years ago

Just a note, but the latest version of APIP seems to have the spec at /api/docs.jsonopenapi instead of docs.json.

2 |

Daniel-C 1 year ago

I am using api-platform/core version 3.2.26 and adding a php comments for $value does not show up in the docs. I had to use ApiProperty like this:

use ApiPlatform\Metadata\ApiProperty;
...
#[ApiProperty(description: 'The estimated value of this treasure, in gold coins.')]
private ?int $value = null;

|

Victor SFCASTS Daniel-C 1 year ago

Hey Daniel,

Hm, it should work. Could you clear the cache and try again? Probably a cache issue. Also, make sure that the description property is available on the ApiProperty class, but I think it should be there.

Probably double-check your config, IIRC it should be something like this:

api_platform:
    metadata_extractors:
        attributes: true

Or probably you need to re-export your docs manually with a CLI command?

I hope this helps!

Cheers!

|

davidmintz 3 years ago

I would like to be able to interact with the database using the shell but I'm having trouble figuring out the magic words to say to docker-compose. Any hints? thanks.

|

Victor SFCASTS davidmintz 3 years ago

Hey David,

I suppose you can connect to the container with:

$ sudo docker exec –it mysql-container /bin/bash

Just use the correct container name instead "mysql-container" in my example.

Another workaround would be to interact with the DB via Symfony CLI - you can leverage the next command:

symfony console doctrine:query:sql "SELECT * FROM table"

Or, you can expose MySQL container ports to your host machine and connect directly to the MySQL via the new (exposed) port - just use your favorite MySQL GUI or just do it via mysql CLI command, you just need to pass correct credentials to connect to the Docker MySQL.

I hope at least one option will work for you ;)

Cheers!

|

Symfony 6.2 API Platform 3.0

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=8.2",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "api-platform/core": "^3.0", // v3.0.8
        "doctrine/annotations": "^1.0", // 1.14.2
        "doctrine/doctrine-bundle": "^2.8", // 2.8.0
        "doctrine/doctrine-migrations-bundle": "^3.2", // 3.2.2
        "doctrine/orm": "^2.14", // 2.14.0
        "nelmio/cors-bundle": "^2.2", // 2.2.0
        "nesbot/carbon": "^2.64", // 2.64.1
        "phpdocumentor/reflection-docblock": "^5.3", // 5.3.0
        "phpstan/phpdoc-parser": "^1.15", // 1.15.3
        "symfony/asset": "6.2.*", // v6.2.0
        "symfony/console": "6.2.*", // v6.2.3
        "symfony/dotenv": "6.2.*", // v6.2.0
        "symfony/expression-language": "6.2.*", // v6.2.2
        "symfony/flex": "^2", // v2.2.4
        "symfony/framework-bundle": "6.2.*", // v6.2.3
        "symfony/property-access": "6.2.*", // v6.2.3
        "symfony/property-info": "6.2.*", // v6.2.3
        "symfony/runtime": "6.2.*", // v6.2.0
        "symfony/security-bundle": "6.2.*", // v6.2.3
        "symfony/serializer": "6.2.*", // v6.2.3
        "symfony/twig-bundle": "6.2.*", // v6.2.3
        "symfony/ux-react": "^2.6", // v2.6.1
        "symfony/validator": "6.2.*", // v6.2.3
        "symfony/webpack-encore-bundle": "^1.16", // v1.16.0
        "symfony/yaml": "6.2.*" // v6.2.2
    },
    "require-dev": {
        "doctrine/doctrine-fixtures-bundle": "^3.4", // 3.4.2
        "symfony/debug-bundle": "6.2.*", // v6.2.1
        "symfony/maker-bundle": "^1.48", // v1.48.0
        "symfony/monolog-bundle": "^3.0", // v3.8.0
        "symfony/stopwatch": "6.2.*", // v6.2.0
        "symfony/web-profiler-bundle": "6.2.*", // v6.2.4
        "zenstruck/foundry": "^1.26" // v1.26.0
    }
}

Previous Chapter

Next Chapter