2017 © Pedro Peláez
 

library api

Basic, silex based, implementation of the API for diMuG (digital Museums Guide)

image

dimug/api

Basic, silex based, implementation of the API for diMuG (digital Museums Guide)

  • Sunday, November 10, 2013
  • by geissler
  • Repository
  • 1 Watchers
  • 0 Stars
  • 6 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

diMuG API

Build Status Coverage Status, (*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

  1. Install composer or just run the following command:
    curl -s http://getcomposer.org/installer | php
  1. Add following to your composer.json and run composer install.
    "require" : {
        "dimug/api": "dev-master"
    }
  1. 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

  1. Create a class which implements the diMuG\APIv1\Interfaces\FinderInterface., (*4)

  2. Create a class which implements the diMuG\APIv1\Interfaces\GlossaryInterface., (*5)

  3. Use the PHPUnit test skeleton files in the dir tests to test your classes., (*6)

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

    vendor/bin/dimug api:validate

or if you prefer Deutsch:, (*8)

    vendor/bin/dimug api:validate de
  1. 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.

The Versions

10/11 2013

dev-master

9999999-dev

Basic, silex based, implementation of the API for diMuG (digital Museums Guide)

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

project