swag-industries/melodiia

Library that helps you build APIs

0.10.4 2024-06-25 10:39 UTC

Requires

• php: >=8.0
• nekland/tools: ^2.5.1
• pagerfanta/doctrine-orm-adapter: ^3.5
• pagerfanta/pagerfanta: ^2.0.1 || ^3.0.0
• symfony/event-dispatcher: ^5.3 || ^6.0 || ^7.0
• symfony/serializer: ^5.3.12 || ^6.0 || ^7.0
• symfony/yaml: ^5.3 || ^6.0 || ^7.0

Requires (Dev)

• behat/behat: 3.14.0
• doctrine/doctrine-bundle: ^2.12.0
• doctrine/orm: ^2.6.6 || ^2.17.0
• fakerphp/faker: ^1.12.1
• friends-of-behat/symfony-extension: ^2.3.0
• friendsofphp/php-cs-fixer: 3.58.0
• justinrainbow/json-schema: ^5.2
• masterminds/html5: ^2.8
• monolog/monolog: ^3.4 || ^2.9
• phpspec/prophecy: ^1.8
• phpspec/prophecy-phpunit: ^2.0.0
• phpunit/phpunit: ^9.6 || ^10.0.0 || ^11.1.3
• psr/container: ^v1.1.1 || ^2.0
• roave/security-advisories: dev-latest
• symfony/asset: ^5.3 || ^6.0 || ^7.0
• symfony/browser-kit: ^5.3 || ^6.0 || ^7.0
• symfony/config: ^5.3 || ^6.0 || ^7.0
• symfony/dependency-injection: ^5.3 || ^6.0 || ^7.0
• symfony/doctrine-bridge: ^5.3 || ^6.0 || ^7.0
• symfony/dotenv: ^5.3 || ^6.0 || ^7.0
• symfony/form: ^5.3 || ^6.0 || ^7.0
• symfony/framework-bundle: ^5.3 || ^6.0 || ^7.0
• symfony/proxy-manager-bridge: ^5.3 || ^6.4
• symfony/security-bundle: ^5.4.20 || ^6.2.6 || ^7.0
• symfony/twig-bundle: ^5.3 || ^6.0 || ^7.0
• symfony/validator: ^5.3 || ^6.0 || ^7.0
• symfony/web-profiler-bundle: ^5.3 || ^6.0 || ^7.0
• twig/twig: ^2.5 || ^3.10

MIT

• Maxime Veber
• BiiG

README

Finally some competitor to ApiPlatform.

Melodiia has been designed to do exactly what you want it does. No magic here. It's just a set of tools that work nicely with Symfony.

Features

• Adds a documentation endpoint with help of swagger
• Set of api responses
• Uses Symfony Form as input
• CRUD controllers
• Error management
• Output format as json-api, a format that has 1.x version

Learn more in the complete documentation.

Requirements

Melodiia requires PHP 8.0 or higher. For php 7.4 you can still use this tag https://github.com/swagindustries/Melodiia/releases/tag/0.10.2

Install

composer require swag-industries/melodiia

The recipe will automatically create the configuration file melodiia.yaml. If you decided to not execute this recipe, please refer to the recipe repository of Symfony.

You may want to read the getting started doc at this point!

If you're experimenting an issue while trying Melodiia, you will maybe find the solution in the troubleshooting section.

One last thing

I (Nek-) designed Melodiia while I was working at Biig in the mean time. This presentation of Melodiia @Biig-io is related to an old version of Melodiia but can still helps you to understand what is melodiia and how it's different from API Platform (TL;DR: Melodiia does less).

Feel free to open an issue, if you encounter problems while implementing Melodiia.