docs: improve guides

Author: soyuka

docs/composer.json

@@ -34,7 +34,8 @@
         "zenstruck/foundry": "^1.31",
         "symfony/http-client": "^6.2",
         "symfony/browser-kit": "^6.2",
-        "justinrainbow/json-schema": "^5.2"
+        "justinrainbow/json-schema": "^5.2",
+        "symfony/asset": "7.0.x-dev"
     },
     "repositories": [
         {

docs/config/bundles.php

@@ -13,7 +13,6 @@
 
 return [
     Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
-    // Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true],
     Symfony\Bundle\SecurityBundle\SecurityBundle::class => ['all' => true],
     Doctrine\Bundle\DoctrineBundle\DoctrineBundle::class => ['all' => true],
     Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle::class => ['all' => true],

docs/config/packages/framework.yaml

@@ -1,3 +1,10 @@
 when@test:
     framework:
         test: true
+api_platform:
+    formats:
+        jsonld: ['application/ld+json']
+        json: ['application/json']
+    defaults:
+        extraProperties:
+            standard_put: true

docs/guides/collect-denormalization-errors.php

@@ -3,6 +3,7 @@
 // slug: create-a-custom-doctrine-filter
 // name: Create a Custom Doctrine Filter
 // executable: true
+// position: 10
 // tags: doctrine
 // ---
 

docs/guides/create-a-custom-doctrine-filter.php

@@ -1,8 +1,9 @@
 <?php
 // ---
-// slug: handle-a-pagination-on-a-custom-collection
-// name: Handle a Pagination on a Custom Collection
+// slug: custom-pagination
+// name: Custom pagination
 // executable: true
+// position: 12
 // tags: state
 // ---
 

docs/guides/create-a-custom-elasticsearch-filter.php

@@ -1,5 +1,5 @@
 <?php
-// --- 
+// ---
 // slug: declare-a-resource
 // name: Declare a Resource
 // position: 1
@@ -10,39 +10,49 @@
 
 // # Declare a Resource
 // This class represents an API resource
-namespace App\ApiResource;
+namespace App\ApiResource {
+    // The `#[ApiResource]` attribute registers this class as an HTTP resource.
+    use ApiPlatform\Metadata\ApiResource;
+    // These are the list of HTTP operations we use to declare a "CRUD" (Create, Read, Update, Delete).
+    use ApiPlatform\Metadata\Get;
+    use ApiPlatform\Metadata\GetCollection;
+    use ApiPlatform\Metadata\Post;
+    use ApiPlatform\Metadata\Patch;
+    use ApiPlatform\Metadata\Delete;
+    use ApiPlatform\Validator\Exception\ValidationException;
+
+    // Each resource has its set of Operations.
+    // Note that the uriTemplate may use the `id` variable which is our unique
+    // identifier on this `Book`.
+    #[ApiResource(
+        operations: [
+            new Get(uriTemplate: '/books/{id}'),
+            // The GetCollection operation returns a list of Books.
+            new GetCollection(uriTemplate: '/books'),
+            new Post(uriTemplate: '/books'),
+            new Patch(uriTemplate: '/books/{id}'),
+            new Delete(uriTemplate: '/books/{id}'),
+        ],
+        // This is a configuration that is shared accross every operations. More details are available at [ApiResource::exceptionToStatus](/reference/Metadata/ApiResource#exceptionToStatus).
+        exceptionToStatus: [
+            ValidationException::class => 422
+        ]
+    )]
+    // If a property named `id` is found it is the property used in your URI template
+    // we recommend to use public properties to declare API resources.
+    class Book
+    {
+        public string $id;
+    }
+}
 
-// The `#[ApiResource]` attribute registers this class as an HTTP resource.
-use ApiPlatform\Metadata\ApiResource;
-// These are the list of HTTP operations we use to declare a "CRUD" (Create, Read, Update, Delete).
-use ApiPlatform\Metadata\Get;
-use ApiPlatform\Metadata\GetCollection;
-use ApiPlatform\Metadata\Post;
-use ApiPlatform\Metadata\Patch;
-use ApiPlatform\Metadata\Delete;
-use ApiPlatform\Validator\Exception\ValidationException;
+// Check our next guide to [provide the resource state](./provide-the-resource-state).
+namespace App\Playground {
+    use Symfony\Component\HttpFoundation\Request;
 
-// Each resource has its set of Operations.
-// Note that the uriTemplate may use the `id` variable which is our unique
-// identifier on this `Book`.
-#[ApiResource(
-    operations: [
-        new Get(uriTemplate: '/books/{id}'),
-        // The GetCollection operation returns a list of Books.
-        new GetCollection(uriTemplate: '/books'),
-        new Post(uriTemplate: '/books'),
-        new Patch(uriTemplate: '/books/{id}'),
-        new Delete(uriTemplate: '/books/{id}'),
-    ],
-    // This is a configuration that is shared accross every operations. More details are available at [ApiResource::exceptionToStatus](/reference/Metadata/ApiResource#exceptionToStatus).
-    exceptionToStatus: [
-        ValidationException::class => 422
-    ]
-)]
-// If a property named `id` is found it is the property used in your URI template
-// we recommend to use public properties to declare API resources.
-class Book
-{
-    public string $id;
+    function request(): Request
+    {
+        return Request::create('/docs', 'GET');
+    }
 }
-// Select the [next example](./hook-a-persistence-layer-with-a-processor) to see how to hook a persistence layer.
+

docs/guides/handle-a-pagination-on-a-custom-collection.php renamed to docs/guides/custom-pagination.php

@@ -1,7 +1,8 @@
 <?php
 // ---
-// slug: doctrine-orm-and-mongodb-odm-service-filters
-// name: Doctrine ORM and MongoDB ODM Service Filters
+// slug: doctrine-orm-service-filter
+// name: Doctrine ORM Service Filters
+// position: 11
 // executable: true
 // ---
 

docs/guides/declare-a-resource.php

@@ -2,7 +2,7 @@
 // ---
 // slug: extend-openapi-documentation
 // name: Extend OpenAPI Documentation
-// position: 10
+// position: 5
 // executable: true
 // ---