docs: 2.7 update

· php8 attributes instead of annotations.
· Removes item & collection operations
· ApiPlatform\Core\Annotation\ to ApiPlatform\Metadata\
· forgotten file names
· adds "declare_strict" at the beginning of php  examples

Author: Thibaudeau Pierre

admin/handling-relations.md

@@ -150,10 +150,11 @@ This API uses the following PHP code:
 ```php
 <?php
 // api/src/Entity/Review.php
+declare(strict_types=1);
 
 namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
@@ -179,11 +180,12 @@ class Review
 ```php
 <?php
 // api/src/Entity/Book.php
+declare(strict_types=1);
 
 namespace App\Entity;
 
 use ApiPlatform\Core\Annotation\ApiFilter;
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Mapping as ORM;

admin/performance.md

@@ -17,12 +17,13 @@ you can make sure the authors are retrieved in one go by writing:
 ```php
 <?php
 // api/src/Entity/Author.php
+declare(strict_types=1);
 
 namespace App\Entity;
 
 use ApiPlatform\Core\Annotation\ApiFilter;
-use ApiPlatform\Core\Annotation\ApiResource;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\SearchFilter;
+use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
@@ -35,8 +36,8 @@ class Author
      * @ORM\Column(type="integer")
      * @ORM\GeneratedValue
      * @ORM\Id
-     * @ApiFilter(SearchFilter::class, strategy="exact")
      */
+    #[ApiFilter(SearchFilter::class, strategy: "exact")]
     public $id;
 
     /**

admin/schema.org.md

@@ -16,11 +16,12 @@ To configure which property should be shown to represent your entity, map the pr
 
 ```php
 // api/src/Entity/Person.php
+...
 
-/**
- * @ApiProperty(iri="http://schema.org/name")
- */
+#[ApiProperty(types: ["http://schema.org/name"])]
 private $name;
+
+...
 ```
 
 ## Emails, URLs and Identifiers

admin/validation.md

@@ -13,12 +13,10 @@ For instance, with API Platform Core as backend, if you write the following:
 <?php
 // api/src/Entity/Book.php
 
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiResource;
 use Symfony\Component\Validator\Constraints as Assert;
 
-/**
- * @ApiResource
- */
+#[ApiResource]
 class Book
 {
     /**
@@ -48,12 +46,10 @@ For example if you have this code:
 <?php
 // api/src/Entity/Book.php
 
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiResource;
 use Symfony\Component\Validator\Constraints as Assert;
 
-/**
- * @ApiResource
- */
+#[ApiResource]
 class Book
 {
     /**

core/content-negotiation.md

@@ -102,12 +102,13 @@ The `format` attribute can be used as a shortcut, it sets both the `input_format
 ```php
 <?php
 // api/src/Entity/Book.php
+declare(strict_types=1);
 
 namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiResource;
 
- #[ApiResource(formats: ['xml', 'jsonld', 'csv' => ['text/csv']])]
+#[ApiResource(formats: ['xml', 'jsonld', 'csv' => ['text/csv']])]
 class Book
 {
     // ...
@@ -127,21 +128,19 @@ You can specify different accepted formats at operation level too, it's especial
 ```php
 <?php
 // api/src/Entity/Book.php
+declare(strict_types=1);
 
 namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiResource;
-
-#[ApiResource(
-    formats: ['jsonld', 'csv' => ['text/csv']],
-    itemOperations: [
-        'patch' => [
-            'input_formats' => [
-                'json' => ['application/merge-patch+json'],
-            ],
-        ],
-    ],
-)]
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Patch;
+use ApiPlatform\Metadata\GetCollection;
+use ApiPlatform\Metadata\Post;
+
+#[ApiResource(formats: ['jsonld', 'csv' => ['text/csv']])]
+#[Patch(inputFormats: ['json' => ['application/merge-patch+json']])]
+#[GetCollection]
+#[Post]
 class Book
 {
     // ...
@@ -227,6 +226,7 @@ services:
 ```php
 <?php
 // api/src/Serializer/CustomItemNormalizer.php
+declare(strict_types=1);
 
 namespace App\Serializer;
 
@@ -274,6 +274,7 @@ flatten or remove overly complex relations:
 ```php
 <?php
 // api/src/Serializer/CustomItemNormalizer.php
+declare(strict_types=1);
 
 namespace App\Serializer;
 

core/controllers.md

@@ -31,6 +31,7 @@ First, let's create your custom operation:
 ```php
 <?php
 // api/src/Controller/CreateBookPublication.php
+declare(strict_types=1);
 
 namespace App\Controller;
 
@@ -90,18 +91,22 @@ The routing has not been configured yet because we will add it at the resource c
 ```php
 <?php
 // api/src/Entity/Book.php
+declare(strict_types=1);
 
-use ApiPlatform\Core\Annotation\ApiResource;
+namespace App\Entity;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\Post;
 use App\Controller\CreateBookPublication;
 
-#[ApiResource(itemOperations: [
-    'get',
-    'post_publication' => [
-        'method' => 'POST',
-        'path' => '/books/{id}/publication',
-        'controller' => CreateBookPublication::class,
-    ],
-])]
+#[ApiResource]
+#[Get]
+#[Post(
+    name: 'post_publication', 
+    uriTemplate: '/books/{id}/publication', 
+    controller: CreateBookPublication::class
+)]
 class Book
 {
     // ...
@@ -155,20 +160,24 @@ You may want different serialization groups for your custom operations. Just con
 ```php
 <?php
 // api/src/Entity/Book.php
+declare(strict_types=1);
+
+namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\Post;
 use App\Controller\CreateBookPublication;
 use Symfony\Component\Serializer\Annotation\Groups;
 
-#[ApiResource(itemOperations: [
-    'get',
-    'post_publication' => [
-        'method' => 'POST',
-        'path' => '/books/{id}/publication',
-        'controller' => CreateBookPublication::class,
-        'normalization_context' => ['groups' => 'publication'],
-    ],
-])]
+#[ApiResource]
+#[Get]
+#[Post(
+    name: 'post_publication', 
+    uriTemplate: '/books/{id}/publication', 
+    controller: CreateBookPublication::class, 
+    normalizationContext: ['groups' => 'publication']
+)]
 class Book
 {
     // ...
@@ -231,19 +240,23 @@ operation attribute:
 ```php
 <?php
 // api/src/Entity/Book.php
+declare(strict_types=1);
 
-use ApiPlatform\Core\Annotation\ApiResource;
+namespace App\Entity;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\Post;
 use App\Controller\CreateBookPublication;
 
-#[ApiResource(itemOperations: [
-    'get',
-    'post_publication' => [
-        'method' => 'POST',
-        'path' => '/books/{id}/publication',
-        'controller' => CreateBookPublication::class,
-        'read' => false,
-    ],
-])]
+#[ApiResource]
+#[Get]
+#[Post(
+    name: 'post_publication', 
+    uriTemplate: '/books/{id}/publication', 
+    controller: CreateBookPublication::class, 
+    read: false
+)]
 class Book
 {
     // ...
@@ -309,14 +322,18 @@ First, let's create your resource configuration:
 ```php
 <?php
 // api/src/Entity/Book.php
+declare(strict_types=1);
+
+namespace App\Entity;
 
-use ApiPlatform\Core\Annotation\ApiResource;
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\Post;
 
-#[ApiResource(itemOperations: [
-    'get',
-    'post_publication' => ['route_name' => 'book_post_publication'],
-    'book_post_discontinuation',
-])]
+#[ApiResource]
+#[Get]
+#[Post(name: 'post_publication', routeName: 'book_post_publication')]
+#[Post(name: 'book_post_discontinuation')]
 class Book
 {
     // ...
@@ -361,6 +378,7 @@ and its related route using annotations:
 ```php
 <?php
 // api/src/Controller/CreateBookPublication.php
+declare(strict_types=1);
 
 namespace App\Controller;
 
@@ -406,6 +424,7 @@ the same thing as the previous example:
 ```php
 <?php
 // api/src/Controller/BookController.php
+declare(strict_types=1);
 
 namespace App\Controller;
 

core/data-providers.md

@@ -23,7 +23,7 @@ Both implementations can also implement a third, optional, interface called
 if you want to limit their effects to a single resource or operation.
 
 In the following examples we will create custom data providers for an entity class called `App\Entity\BlogPost`.
-Note, that if your entity is not Doctrine-related, you need to flag the identifier property by using `@ApiProperty(identifier=true)` for things to work properly (see also [Entity Identifier Case](serialization.md#entity-identifier-case)).
+Note, that if your entity is not Doctrine-related, you need to flag the identifier property by using `#[ApiProperty(identifier: true)]` for things to work properly (see also [Entity Identifier Case](serialization.md#entity-identifier-case)).
 
 ## Custom Collection Data Provider