2017 © Pedro Peláez
 

library apigenerator-bundle

Get an ajax crud api out of the box

image

tbn/apigenerator-bundle

Get an ajax crud api out of the box

  • Wednesday, February 22, 2017
  • by thomasbeaujean
  • Repository
  • 2 Watchers
  • 0 Stars
  • 108 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 6 % Grown

The README.md

/!\ DEPRECATED

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, (*1)

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:, (*2)

    htpp://your_app/_apigenerator-configuration

It displays the entities and the rights associated for the Api Generator, (*3)

TODO

Persist OneToMany collections, (*4)

Remove entities, (*5)

The Versions