it works propably

Author: patrykbaszak

README.md

@@ -1,27 +1,43 @@
-# Skeleton #
+# Extended Api Doc Bundle #
 
-A minimal project that allows you to quickly create a new project based on `Symfony` using useful tools: `standard-version`, `php-cs-fixer`, `phpstan`, `phpunit`, `docker`, `xdebug` and my own `starting script`. It is ready to support debugging with **Visual Studio Code** - just look into .env.local ;). 
+## Installation
 
-### WHY?
-Because personally, every time I start a new project, or a library for it, I have to do all this manually. For this, I made application skeletons for different uses: `cli`, `api`, `library`, and `bundle`, to speed up and standardize my own work. These skeletons uses this project.
-
-### How to start
-
-Create directory for your project, get in (`cd {Your directory}`) and run command:
-```sh
-composer create-project PBaszak/skeleton . --no-interaction
+```yaml
+# config/routes.yaml
+...
+extended_api_doc:
+    resource: '@ExtendedApiDocBundle/Resources/routes/*'
 ```
 
-(Everytime) Start local environment using this command:
-```sh
-bash start.sh
+```yaml
+# config/packages/nelmio_api_doc.yaml
+parameters:
+    app_title: '%env(APP_TITLE)%'
+    app_description: '%env(APP_DESCRIPTION)%'
+    app_version: '%env(APP_VERSION)%'
+    app_commit_sha_short: '%env(APP_COMMIT_SHA_SHORT)%'
+
+nelmio_api_doc:
+    documentation:
+        info:
+            title: '%app_title%'
+            description: '%app_description%'
+            version: '%app_version% (%app_commit_sha_short%)'
+    areas: # to filter documented areas
+        path_patterns:
+            - ^/api(?!/doc(.json|.yaml)?$)
 ```
 
-and remove `CHANGELOG.md` (because it's owned by skeleton project. Your project will be have generated `CHANGELOG.md` after first release):
+## Usage
+
+## Development
+
+### How to start
+
+Start local environment using this command:
 ```sh
-rm CHANGELOG.md
+bash start.sh
 ```
-and voila! Your local environment is ready to development basic php app with useful tools.
 
 ### How to use **Standard Version**
 
@@ -30,11 +46,6 @@ If You don't have node_modules directory run:
 npm install
 ```
 
-First release:
-```sh
-npm run version:first-release
-```
-
 `Major`, `Minor`, `Patch` version update:
 ```sh
 npm run version:major

composer.json

@@ -38,7 +38,8 @@
         "phpstan/phpdoc-parser": "*",
         "phpstan/phpstan": "*",
         "phpstan/phpstan-symfony": "*",
-        "phpunit/phpunit": "*"
+        "phpunit/phpunit": "*",
+        "symfony/browser-kit": "^6"
     },
     "config": {
         "allow-plugins": {
@@ -86,6 +87,7 @@
             "@code:analyse",
             "@phpunit"
         ],
+        "test:e2e": "@phpunit --group e2e tests",
         "test:unit": "@phpunit --group unit tests"
     },
     "conflict": {

composer.lock

@@ -5,4 +5,5 @@
     Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true],
     Twig\Extra\TwigExtraBundle\TwigExtraBundle::class => ['all' => true],
     Nelmio\ApiDocBundle\NelmioApiDocBundle::class => ['all' => true],
+    PBaszak\ExtendedApiDoc\ExtendedApiDocBundle::class => ['all' => true],
 ];

config/bundles.php

@@ -0,0 +1,9 @@
+nelmio_api_doc:
+    documentation:
+        info:
+            title: Title
+            description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+            version: '1.0.0'
+    areas: # to filter documented areas
+        path_patterns:
+            - ^/api(?!/doc(.json|.yaml)?$)

config/packages/nelmio_api_doc.yaml

@@ -0,0 +1,5 @@
+controllers:
+    resource: ../tests/Assets/
+    type: attribute
+extended_api_doc:
+    resource: '@ExtendedApiDocBundle/Resources/routes/*'

config/routes.yaml

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PBaszak\ExtendedApiDoc\Tests\Assets;
+
+use OpenApi\Attributes as OA;
+
+class Status
+{
+    public function __construct(
+        #[OA\Property(type: 'string', example: 'ok')]
+        public readonly string $status = 'ok',
+    ) {
+    }
+}

tests/Assets/.gitignore

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PBaszak\ExtendedApiDoc\Tests\Assets;
+
+use Nelmio\ApiDocBundle\Annotation\Model;
+use OpenApi\Attributes as OA;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+
+class TestController extends AbstractController
+{
+    /**
+     * Return the status of the API.
+     */
+    #[OA\Tag(name: 'Status')]
+    #[OA\Response(
+        response: 200,
+        description: 'Status of the API.',
+        content: new OA\JsonContent(
+            ref: new Model(
+                type: Status::class,
+            )
+        )
+    )]
+    #[Route('/api/status', name: 'api_status', methods: ['GET'])]
+    public function __invoke(): Response
+    {
+        return $this->json(new Status());
+    }
+}