https://github.com/violines/rest-bundle

Symfony Bundle to create REST APIs
https://github.com/violines/rest-bundle

bundle json json-api rest rest-api symfony symfony-bundle

Last synced: 2 months ago
JSON representation

Symfony Bundle to create REST APIs

• Host: GitHub
• URL: https://github.com/violines/rest-bundle
• Owner: violines
• License: mit
• Created: 2019-12-23T13:40:49.000Z (about 5 years ago)
• Default Branch: 0.x
• Last Pushed: 2022-03-09T13:08:06.000Z (almost 3 years ago)
• Last Synced: 2024-09-29T13:46:58.682Z (3 months ago)
• Topics: bundle, json, json-api, rest, rest-api, symfony, symfony-bundle
• Language: PHP
• Homepage:
• Size: 474 KB
• Stars: 35
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## About

violines/rest-bundle is a Symfony Bundle to create REST APIs. It focusses on HTTP standards and integrates the symfony/serializer and symfony/validator.

[![build](https://github.com/violines/rest-bundle/workflows/build/badge.svg)](https://github.com/violines/rest-bundle)

[![Code Coverage](https://codecov.io/gh/violines/rest-bundle/branch/master/graph/badge.svg)](https://codecov.io/gh/violines/rest-bundle/)

[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fviolines%2Frest-bundle%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/violines/rest-bundle/master)

[![type coverage](https://shepherd.dev/github/violines/rest-bundle/coverage.svg)](https://shepherd.dev/github/violines/rest-bundle)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=violines_rest-bundle&metric=sqale_index)](https://sonarcloud.io/dashboard?id=violines_rest-bundle)

[![Software License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

[![Wiki Docs](https://img.shields.io/badge/wiki-docs-B29700)](https://github.com/violines/rest-bundle/wiki)

### Features

* Request body or query string to object conversion

* Response building from objects

* Configurable content negotiation

* Events to control symfony/serializer context

* Integration of symfony/validator

* Error Handling

* Optional Logging

### Compatible with...

* Symfony 5.4 + 6

* PHP 8 + 8.1

### Designed for...

modern architectures that apply Domain Driven Design principles, hexagonal architecture or similar concepts.

### Install

```sh

composer require violines/rest-bundle

```

### How does it work?

1. Create any PHP class (Entity, DTO, Command, Query, etc) and add the `#[HttpApi]` attribute or `@HttpApi` annotation

1. Use any property attributes/annotations from symfony/serializer or symfony/validator

1. Declare this PHP class as type of a controller argument

1. Return an instance of this PHP class in the controller

### Show Case

Find a sample of usage under: https://github.com/violines/rest-bundle-showcase.

## Example

```php

orderRepository->findOrders();

    }

    #[Route('/order/{id}', methods: ['GET'], name: 'find_order')]

    public function findOrder(int $id): Order

    {

        $order = $this->orderRepository->find($id);

        if (null === $order) {

            throw NotFoundException::id($id);

        }

        return $order;

    }

    /**

     * @param Order[] $orders

     */

    #[Route('/orders/create', methods: ['POST'], name: 'create_orders')]

    public function createOrders(Order ...$orders): Response

    {

        $this->orderRepository->createOrders($orders);

        return new Response(null, Response::HTTP_CREATED);

    }

    #[Route('/order/create', methods: ['POST'], name: 'create_order')]

    public function createOrder(Order $order): Response

    {

        $this->orderRepository->create($order);

        return new Response(null, Response::HTTP_CREATED);

    }

}

```

### Wiki

For more details please check [violines/rest-bundle Wiki](https://github.com/violines/rest-bundle/wiki).

## Development setup

1. copy docker/.env.dist to docker/.env and adjust to your needs

1. cd docker/

1. pull latest image(s): docker-compose pull

1. create the container(s): docker-compose up -d

1. run tests with `docker-compose exec php80 composer run test`