akrabat/apigility-xml

Apigility module providing XML content-negotiation features

dev-master 2018-02-21 15:35 UTC

Requires

• php: ^5.6 || ^7.0
• zendframework/zend-component-installer: ^1.0 || ^2.0
• zendframework/zend-serializer: ^2.7.7 || ^3.0.1
• zendframework/zend-stdlib: ^2.7.7 || ^3.0.1
• zendframework/zend-xml2json: ^3.0
• zfcampus/zf-apigility: ^1.3
• zfcampus/zf-content-negotiation: ^1.2

Requires (Dev)

• squizlabs/php_codesniffer: ^3.2

MIT

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

README

This is an Apigility module to provide XML content-negotiation features. It allows for the rendering of payloads in XML and HAL+XML formats. It also supports ingesting HTTP bodies that are in XML format if the content-type is application/xml

The response type is based on Accept header:

• application/xml (or application/*+xml) renders content in XML
• application/hal+json (or application/*+json) renders content in HalJson.

Installation

1. Install the module using composer:

    $ composer require akrabat/apigility-xml
   

2. Add Akrabat\ApigilityXml to modules.config.php:

    return [
    	...,
        'Akrabat\ApigilityXml',
        ....
    ]
   

3. In the Apigility admin, select your API and change Content Negotiation Selector to HalJsonXML

4. Add application/xml to Accept whitelist and Content-Type whitelist. Add other headers if needed.

5. Save configuration

Credits

This module is a fork of https://github.com/diegograssato/apigility-xml-negotiation which appears to be a fork of https://github.com/zpetr/apigility-xmlnegotiation which was inspired by the https://github.com/markushausammann's ApigilityXml.

Thanks to everyone who came before me!