diMuG API
, (*1)
This is an sample implementation of an API to provide a data source for diMuG - the digital Museums Guide. It's based on
silex., (*2)
Installation
- Install composer or just run the following command:
curl -s http://getcomposer.org/installer | php
- Add following to your composer.json and run composer install.
"require" : {
"dimug/api": "dev-master"
}
- Run the additional install script via the console by running the following command:
vendor/bin/dimug api:install
or if you prefer Deutsch:, (*3)
vendor/bin/dimug api:install de
How to connect your data source
-
Create a class which implements the diMuG\APIv1\Interfaces\FinderInterface., (*4)
-
Create a class which implements the diMuG\APIv1\Interfaces\GlossaryInterface., (*5)
-
Use the PHPUnit test skeleton files in the dir tests to test your classes., (*6)
-
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:, (*7)
vendor/bin/dimug api:validate
or if you prefer Deutsch:, (*8)
vendor/bin/dimug api:validate de
- 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.