zpetr/apigility-routeaccept

Routing based on Accept header for Apigility

1.0.3 2021-04-12 22:18 UTC

Requires

• php: >=5.3.23
• zfcampus/zf-apigility: ^1.4

MIT

• Petr Guelin (Glushchenko)

• route
• api
• zf2
• module
• header
• accept
• apigility

README

Routing based on Accept header of request

This module give you possibility to have any number of APIs with the same 'route' name.

Example:

Imagine that you have API car and API moto. If you create route named brand for both APIs, apigility will redirect you always to the last one. RouteAccept module offer a possibility to use API which correspond to the Accept Header.

So,

• request to /brand with Accept header "application/vnd.car.v1+json" will give you something like:

{
    "brand": [
		{
			"id": 1,
			"name": "BMW"
		},
		{
			"id": 2,
			"name": "Ford"
		},
		...
	]
}

• request to /brand with Accept header "application/vnd.moto.v1+json" will give you something like:

{
    "brand": [
		{
			"id": 1,
			"name": "Harley-Davidson"
		},
		{
			"id": 2,
			"name": "Kawasaki"
		},
		...
	]
}

Installation

Install composer in your project

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

Define dependencies in your composer.json file

{
    "require": {
        "zpetr/apigility-routeaccept" : "1.*"
    }
}

Finally install dependencies

php composer.phar install

or update it

php composer.phar update

Usage

• Add zPetr\RouteAccept to config/modules.config.php:

	return array(
    	'modules' => array(
        	...,
            'zPetr\\RouteAccept',
            ....
		)
	)     

• Create APIs and routes (you can use the same names for different routes now)
• Use it!