ongr/api-bundle

Api bundle for ONGR platform.

ONGR Api Bundle

Api Bundle allows rapid setup of RESTful API to simplify Elasticsearch data access for the remote clients., _(*1)

, _(*2)

Documentation, _(*3)

The source of the documentation is stored in the Resources/doc/ folder in this bundle., _(*4)

Read the API Bundle Documentation, _(*5)

Setup the bundle

This example assumes that you already have configured Elasticsearch bundle. If you haven't, here's a quick setup guide on how to do it., _(*6)

Step 1: Install

Api bundle is installed using Composer., _(*7)

composer require ongr/api-bundle "~1.0"

Step 2: Enable bundle in the AppKernel

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new JMS\SerializerBundle\JMSSerializerBundle(),
        new ONGR\ElasticsearchBundle\ONGRElasticsearchBundle(),
        new ONGR\ApiBundle\ONGRApiBundle(),
    );
}

API Bundle requires JMS Serializer to work with JSON and XML, _(*8)

Step 3: Add configuration

Add minimal configuration for Api bundle to the config.yml., _(*9)

#app/config/config.yml

ongr_api:
    default_encoding: json
        versions:
            v3:
                endpoints:
                    product:
                        repository: es.manager.default.product

The example above shows a minimal configuration. To learn more take a look at the configuration page., _(*10)

Add routing, _(*11)

#app/config/routing.yml

ongr_api_routing:
    resource: @ONGRApiBundle/Resources/config/routing.yml
    prefix: /api

You can specify prefix like you want, api is only the example., _(*12)

Step 4: That's it

Its ready to use. API Bundle will generate new url endpoints by your configuration, by previous configuration you will have: <yourdomain.com>/api/v3/product, _(*13)

What's next ?

Head to configuration page to learn how to get most of your API or take a look at the [basic usage example][6], _(*14)

License

This bundle is covered by the MIT license. Please see the complete license in the bundle LICENSE file., _(*15)