iamluc/qandidate-toggle-api repository overview

⁠Toggle API

An API for managing your toggles, uses Redis to store the toggle collection.

⁠About

Read our blog post series about this repository at:

• http://labs.qandidate.com/blog/2014/08/18/a-new-feature-toggling-library-for-php/⁠
• http://labs.qandidate.com/blog/2014/08/19/open-sourcing-our-feature-toggle-api-and-ui/⁠

⁠Installation

Install the dependencies with composer:

$ composer install

Configuration is determined based on environment variables. Copy .env.dist to .env and adjust where needed. You can override the values in the file with environment values. The default configuration is mainly for local development.

The environment variable TOGGLE__ALLOWED_ORIGINS should be valid JSON. This is to allow arrays.

⁠Running the tests

We use PHPUnit, so to run the tests simply run:

$ vendor/bin/phpunit

⁠Running the app

With your favorite webserver (or with php -S for local testing) point your document root to the web folder.

⁠Endpoints

⁠Retrieve the toggles

GET /toggles

⁠Create or update a toggle

PUT /toggles/{name}

Example request:

{
   "conditions" : [
      {
         "name" : "operator-condition",
         "operator" : {
            "name" : "less-than",
            "value" : "1337"
         },
         "key" : "user_id"
      }
   ],
   "name" : "foo",
   "status" : "conditionally-active",
   "originalName" : "foo"
}

NOTE: PUT doesn't remove the previous toggle if you rename it. So if you want to rename foo to bar, you would have to PUT bar and DELETE foo.

⁠Delete a toggle

DELETE /toggles/{name}

⁠License

MIT, see LICENSE.