diegograssato/apigility-xml-negotiation

Apigility Module providing XML content-negotiation features

v1.0 2017-03-12 02:16 UTC

Requires

• php: ^5.6 || ^7.0
• zendframework/zend-component-installer: ^1.0 || ^0.5 || ^1.0.0-dev@dev
• zendframework/zend-serializer: ^2.7.7 || ^3.0.1
• zendframework/zend-stdlib: ^2.7.7 || ^3.0.1
• zfcampus/zf-apigility: ^1.3
• zfcampus/zf-content-negotiation: ^1.2

MIT

• Diego Pereira Grassato

• xml
• api
• zend
• module
• negotiation
• apigility
• content-negotiation
• zf3

README

Apigility Module providing XML content-negotiation features

This module is inspired from [abandoned ApigilityXml project][source] for [Markus][source_dev]! [source]: https://github.com/zpetr/apigility-xmlnegotiation [source_dev]: https://github.com/markushausammann

Necessary infrastructure to handle XML with ZF Apigility with HAL structure.

Response type is based on Accept header :

• request that specifies application/xml (or application/*+xml) get the content in XML
• application/hal+json (or application/*+json) request get the content in HalJson as usual.

Installation

Install composer in your project

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

Define dependencies in your composer.json file

{
    "require": {
        "diegograssato/apigility-xml-negotiation" : "dev-master"
    }
}

Finally install dependencies

php composer.phar install

or update it

php composer.phar update

Usage

• Add ZF\ContentNegotiation\XML to modules.config.php:

	return array(
    	...,
        'ZF\ContentNegotiation\XML',
        ....
	)     

• Go to admin, select your API and change Content Negotiation Selector to HalJsonXML
• Add application/xml to Accept whitelist and Content-Type whitelist. Add other headers if needed.
• Save configuration