https://github.com/valantic/pimcore-api-documentation

Pimcore API Documentation Bundle
https://github.com/valantic/pimcore-api-documentation

Last synced: 8 days ago
JSON representation

Pimcore API Documentation Bundle

• Host: GitHub
• URL: https://github.com/valantic/pimcore-api-documentation
• Owner: valantic
• License: mit
• Created: 2023-12-06T12:30:29.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-04-10T11:24:42.000Z (7 months ago)
• Last Synced: 2024-04-14T12:52:20.275Z (7 months ago)
• Language: PHP
• Size: 364 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pimcore API documentation bundle

[![Latest Version on Packagist](https://img.shields.io/packagist/v/valantic/pimcore-api-documentation.svg?style=flat-square)](https://packagist.org/packages/valantic/pimcore-api-documentation)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![PHP Checks](https://github.com/valantic/pimcore-api-documentation/actions/workflows/phpstan.yml/badge.svg)](https://github.com/valantic/pimcore-api-documentation/actions/workflows/phpstan.yml)

This package is developed by [valantic CEC Schweiz](https://www.valantic.com/en/services/digital-business/) and is under active development.

Bundle is used for generating API documentation based on API controllers.

## Requirements

- Pimcore >= 11.0.0

## Installation

1. `composer require valantic/pimcore-api-documentation`

2. Add `ValanticPimcoreApiDocumentationBundle` to `config/bundles.php`

## Usage

```php

class ProductController implements \Valantic\PimcoreApiDocumentationBundle\Http\Controller\ApiControllerInterface

{

    use \Valantic\PimcoreApiDocumentationBundle\Controller\ApiControllerTrait;

    #[Route(path: '/product', name: 'rest_api_product_create', methods: Request::METHOD_POST)]

    public function create(ProductCreateRequest $request): ProductCreateResponse|\Valantic\PimcoreApiDocumentationBundle\Http\Response\BadRequestResponse

    {

        $errors = $this->validateRequest($request);

        if (count($errors) !== 0) {

            return new \Valantic\PimcoreApiDocumentationBundle\Http\Response\BadRequestResponse($errors);

        }

        return new ProductCreateResponse(/* ... */);

    }

}

use Symfony\Component\Validator\Constraints as Assert;

class ProductCreateRequest implements \Valantic\PimcoreApiDocumentationBundle\Http\Request\Contracts\HasJsonPayload

{

    #[Assert\NotBlank]

    public ?string $name = null;

    #[Assert\NotBlank]

    public ?string $description = null;

}

class ProductCreateResponse implements \Valantic\PimcoreApiDocumentationBundle\Http\Response\ApiResponseInterface

{

    public static function status(): int

    {

        return \Symfony\Component\HttpFoundation\Response::HTTP_CREATED;

    }

    public static function getDtoClass(): string|false

    {

        return ProductCreateDto::class;

    }

}

class ProductCreateDto

{

    public function __construct(

        public ?int $id,

    ) {}

}

```