Api bundle for ONGR platform.

Installs: 11 534

Dependents: 2

Suggesters: 0

Security: 0

Stars: 9

Watchers: 19

Forks: 10

Open Issues: 5


v1.0.0 2016-04-06 20:44 UTC

This package is auto-updated.

Last update: 2021-12-25 00:21:19 UTC


Api Bundle allows rapid setup of RESTful API to simplify Elasticsearch data access for the remote clients.

Build Status


The source of the documentation is stored in the Resources/doc/ folder in this bundle.

Read the API Bundle Documentation

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.

Step 1: Install

Api bundle is installed using Composer.

composer require ongr/api-bundle "~1.0"

Step 2: Enable bundle in the AppKernel

// 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

Step 3: Add configuration

Add minimal configuration for Api bundle to the config.yml.


    default_encoding: json
                        repository: es.manager.default.product

The example above shows a minimal configuration. To learn more take a look at the configuration page.

Add routing


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

You can specify prefix like you want, api is only the example.

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: <>/api/v3/product

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


This bundle is covered by the MIT license. Please see the complete license in the bundle LICENSE file.