search

symfony / recipes

Symfony Recipes Repository
https://github.com/symfony/recipes/blob/flex/main/RECIPES.md
MIT License
964 stars 476 forks source link

api-platform 3.3 configuration #1312

Closed soyuka closed 4 months ago

soyuka commented 5 months ago
Q A
License MIT
Doc issue/PR symfony/symfony-docs#...
github-actions[bot] commented 5 months ago

Thanks for the PR 😍

How to test these changes in your application

  1. Define the SYMFONY_ENDPOINT environment variable:

    # On Unix-like (BSD, Linux and macOS)
export SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1312/index.json
# On Windows
SET SYMFONY_ENDPOINT=https://raw.githubusercontent.com/symfony/recipes/flex/pull-1312/index.json

  2. Install the package(s) related to this recipe:

    composer req 'symfony/flex:^1.16'
composer req 'api-platform/core:^3.3'

  3. Don't forget to unset the SYMFONY_ENDPOINT environment variable when done:

    # On Unix-like (BSD, Linux and macOS)
unset SYMFONY_ENDPOINT
# On Windows
SET SYMFONY_ENDPOINT=

Diff between recipe versions

In order to help with the review stage, I'm in charge of computing the diff between the various versions of patched recipes. I'm going keep this comment up to date with any updates of the attached patch.

api-platform/core

2.1 vs 2.5 ```diff diff --git a/api-platform/core/2.1/config/packages/api_platform.yaml b/api-platform/core/2.5/config/packages/api_platform.yaml index e453d1d..2eb7b4c 100644 --- a/api-platform/core/2.1/config/packages/api_platform.yaml +++ b/api-platform/core/2.5/config/packages/api_platform.yaml @@ -1,3 +1,7 @@ api_platform: mapping: paths: ['%kernel.project_dir%/src/Entity'] + patch_formats: + json: ['application/merge-patch+json'] + swagger: + versions: [3] ```
2.5 vs 3.0 ```diff diff --git a/api-platform/core/2.5/config/packages/api_platform.yaml b/api-platform/core/2.5/config/packages/api_platform.yaml deleted file mode 100644 index 2eb7b4c..0000000 --- a/api-platform/core/2.5/config/packages/api_platform.yaml +++ /dev/null @@ -1,7 +0,0 @@ -api_platform: - mapping: - paths: ['%kernel.project_dir%/src/Entity'] - patch_formats: - json: ['application/merge-patch+json'] - swagger: - versions: [3] diff --git a/api-platform/core/2.5/manifest.json b/api-platform/core/3.0/manifest.json index a886a48..af16452 100644 --- a/api-platform/core/2.5/manifest.json +++ b/api-platform/core/3.0/manifest.json @@ -1,6 +1,6 @@ { "bundles": { - "ApiPlatform\\Core\\Bridge\\Symfony\\Bundle\\ApiPlatformBundle": ["all"] + "ApiPlatform\\Symfony\\Bundle\\ApiPlatformBundle": ["all"] }, "copy-from-recipe": { "config/": "%CONFIG_DIR%/", diff --git a/api-platform/core/2.5/src/Entity/.gitignore b/api-platform/core/3.0/src/ApiResource/.gitignore similarity index 100% rename from api-platform/core/2.5/src/Entity/.gitignore rename to api-platform/core/3.0/src/ApiResource/.gitignore ```
3.0 vs 3.1 ```diff diff --git a/api-platform/core/3.1/config/packages/api_platform.yaml b/api-platform/core/3.1/config/packages/api_platform.yaml new file mode 100644 index 0000000..41c7993 --- /dev/null +++ b/api-platform/core/3.1/config/packages/api_platform.yaml @@ -0,0 +1,10 @@ +api_platform: + title: Hello API Platform + version: 1.0.0 + # Good defaults for REST APIs + defaults: + stateless: true + cache_headers: + vary: ['Content-Type', 'Authorization', 'Origin'] + extra_properties: + standard_put: true ```
3.1 vs 3.2 ```diff diff --git a/api-platform/core/3.1/config/packages/api_platform.yaml b/api-platform/core/3.2/config/packages/api_platform.yaml index 41c7993..4d0c3f7 100644 --- a/api-platform/core/3.1/config/packages/api_platform.yaml +++ b/api-platform/core/3.2/config/packages/api_platform.yaml @@ -1,10 +1,18 @@ api_platform: title: Hello API Platform version: 1.0.0 - # Good defaults for REST APIs + formats: + jsonld: ['application/ld+json'] + docs_formats: + jsonld: ['application/ld+json'] + jsonopenapi: ['application/vnd.openapi+json'] + html: ['text/html'] defaults: stateless: true cache_headers: vary: ['Content-Type', 'Authorization', 'Origin'] extra_properties: standard_put: true + rfc_7807_compliant_errors: true + event_listeners_backward_compatibility_layer: false + keep_legacy_inflector: false ```
3.2 vs 3.3 ```diff diff --git a/api-platform/core/3.2/config/packages/api_platform.yaml b/api-platform/core/3.3/config/packages/api_platform.yaml index 4d0c3f7..e4233dc 100644 --- a/api-platform/core/3.2/config/packages/api_platform.yaml +++ b/api-platform/core/3.3/config/packages/api_platform.yaml @@ -14,5 +14,5 @@ api_platform: extra_properties: standard_put: true rfc_7807_compliant_errors: true - event_listeners_backward_compatibility_layer: false keep_legacy_inflector: false + use_symfony_listeners: true ```