diMuG API

This is an sample implementation of an API to provide a data source for diMuG - the digital Museums Guide. It's based on silex.

Installation

1. Install composer or just run the following command:

    curl -s http://getcomposer.org/installer | php

2. Add following to your composer.json and run composer install.

    "require" : {
        "dimug/api": "dev-master"
    }

3. Run the additional install script via the console by running the following command:

    vendor/bin/dimug api:install

or if you prefer Deutsch:

    vendor/bin/dimug api:install de

How to connect your data source

1. Create a class which implements the diMuG\APIv1\Interfaces\FinderInterface.

2. Create a class which implements the diMuG\APIv1\Interfaces\GlossaryInterface.

3. Use the PHPUnit test skeleton files in the dir tests to test your classes.

4. Edit the configuration files config/configuration.yml and config/security.yml so that they represent your data. Use the following console command to test your configuration files:

    vendor/bin/dimug api:validate

or if you prefer Deutsch:

    vendor/bin/dimug api:validate de

6. If everything is working, upload your files to your webserver and point your web-root to web. For further configuration details look into the silex documenation.