tbn/apigenerator-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (dev-master) of this package.

Get an ajax crud api out of the box

dev-master 2021-01-26 14:51 UTC

Requires

• tbn/getsetforeignnormalizer-bundle: dev-master

Requires (Dev)

• php: >=5.3.0
• doctrine/data-fixtures: ^1.1
• doctrine/doctrine-bundle: >=1.4
• doctrine/orm: ~2.2,>=2.2.3,<2.5
• nelmio/alice: >=2.1
• phpunit/phpunit: ~4.4
• sensio/distribution-bundle: >=4.0
• sensio/framework-extra-bundle: ~3.0,>=3.0.2
• symfony/class-loader: 2.3.*
• symfony/symfony: >=2.7
• twig/extensions: >=1.0

Unknown License

README

This bundle is not maintained anymore, if you are looking for an API out of the box, please check https://github.com/api-platform/api-platform

Installation

	composer require "tbn/apigenerator-bundle"

Enable the bundle in the AppKernel for the dev environment

	...
	new tbn\ApiGeneratorBundle\ApiGeneratorBundle();
   ...

Add routing

	tbn_api_generator:
	    resource: "@ApiGeneratorBundle/Resources/config/routing.yml"

Add routing for development environment

	tbn_api_generator_dev:
	    resource: "@ApiGeneratorBundle/Resources/config/routing_dev.yml"

Configuration

	api_generator:
	    default: #The default behaviour for all entities
	        create: false #optionnal
	        update: false #optionnal
	        delete: false #optionnal
	        get_one: false      #optionnal #get one entity (only foreign keys are sent)
	        get_one_deep: false #optionnal #get one entity but the foreign entities are completed normalized too
	        get_all: false      #optionnal #get all entities
	        get_all_deep: false #optionnal #get all entities but the foreign entities are completed normalized too
	    entity:  #Specify the rights for specific entities
                    user: #the entity alias
                        class: "FrontBundle\\Entity\\SomeEntity" #mandatory
	            create: true  #optionnal
	            update: false #optionnal
	            delete: true  #optionnal
	            get_one: true #optionnal
	            get_one_deep: true #optionnal
	            get_all: true #optionnal
	            get_all_deep: true #optionnal

Usage

Go to the url:

	htpp://your_app/_apigenerator-configuration

It displays the entities and the rights associated for the Api Generator

TODO

Persist OneToMany collections

Remove entities