PHPackages apix/apix - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. apix/apix ActiveApplication[Framework](/categories/framework) apix/apix ========= RESTful API server for structured and self-documenting resources over JSON, XML, ... 0.3.10(10y ago)91614[1 issues](https://github.com/frqnck/apix/issues)[1 PRs](https://github.com/frqnck/apix/pulls)BSD-3-ClausePHPPHP >=5.3 Since Dec 12Pushed 4y ago4 watchersCompare [ Source](https://github.com/frqnck/apix)[ Packagist](https://packagist.org/packages/apix/apix)[ Docs](http://github.com/frqnck/apix)[ RSS](/packages/apix-apix/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (5)Versions (11)Used By (0) APIx, RESTful services for PHP [![Build Status](https://camo.githubusercontent.com/d8282ed45a1d1c3f68316e9c60623039e6f4e0a18fd1b14735bb37a41a1b4113/68747470733a2f2f7472617669732d63692e6f72672f6672716e636b2f617069782e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/frqnck/apix) =============================================================================================================================================================================================================================================================================================== [](#apix-restful-services-for-php-) [![Latest Stable Version](https://camo.githubusercontent.com/e8200ad60f1c0ee406ca5de3fd10c2a021c4eb2963a7102f3a37bc1da8300fa0/68747470733a2f2f706f7365722e707567782e6f72672f617069782f617069782f762f737461626c652e737667)](https://packagist.org/packages/apix/apix) [![Build Status](https://camo.githubusercontent.com/f378c353f521a1fac7154377c848bafbe85f0471467d94d75d5d1c30adfde15c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6672716e636b2f617069782f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/frqnck/apix/build-status/master) [![Code Quality](https://camo.githubusercontent.com/8f29ebaa20ce7f1c71238032d40610c7d4ffa5b9b7716a6371602a43393ece7c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6672716e636b2f617069782f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/frqnck/apix/?branch=master) [![Code Coverage](https://camo.githubusercontent.com/23371f4bafc04a640e8987cda5134a98d735c70217a204455dae330893438cf5/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6672716e636b2f617069782f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/frqnck/apix/?branch=master) [![License](https://camo.githubusercontent.com/51c8ad4213ae8749b3a127fb8935dad79d0f5d9ca32fc3a08e7f389dfc1e2695/68747470733a2f2f706f7365722e707567782e6f72672f617069782f617069782f6c6963656e73652e737667)](https://packagist.org/packages/apix/apix) APIx is a (micro-)framework to build RESTful Web services. It will run alognside your existing framework/application with minimum fuss. Some of its features: - Supports **many data inputs** such as GET/POST parameters, XML, JSON, CSV, ... - Provides **various output representation** such as XML, JSONP, HTML, PHP, ... - Provides **on-demand resources documention**, using GET /help or 'OPTIONS'. - Uses **annotations to document** and **set service behaviours**. - Handles **most HTTP methods**, including PUT, DELETE, HEAD, OPTIONS and PATCH (TRACE to some extend). - Bundle with **many plugins and adapters** for Authentification and ACL, caching... - **Follows the standards** such as [rfc2616](http://www.ietf.org/rfc/rfc2616 "Hypertext Transfer Protocol -- HTTP/1.1") [rfc2616](http://www.ietf.org/rfc/rfc2616 "Hypertext Transfer Protocol -- HTTP/1.1"), [rfc2617](http://www.ietf.org/rfc/rfc2617 "HTTP Authentication: Basic and Digest Access Authentication") [rfc2617](http://www.ietf.org/rfc/rfc2617 "HTTP Authentication: Basic and Digest Access Authentication"), [rfc2388](http://www.ietf.org/rfc/rfc2388 "Returning Values from Forms: multipart/form-data") [rfc2388](http://www.ietf.org/rfc/rfc2388 "Returning Values from Forms: multipart/form-data"), [rfc2854](http://www.ietf.org/rfc/rfc2854 "The 'text/html' Media Type") [rfc2854](http://www.ietf.org/rfc/rfc2854 "The 'text/html' Media Type"), [rfc4627](http://www.ietf.org/rfc/rfc4627 "The application/json Media Type for JavaScript Object Notation (JSON)") [rfc4627](http://www.ietf.org/rfc/rfc4627 "The application/json Media Type for JavaScript Object Notation (JSON)"), [rfc4329](http://www.ietf.org/rfc/rfc4329 "Scripting Media Types") [rfc4329](http://www.ietf.org/rfc/rfc4329 "Scripting Media Types"), [rfc2046](http://www.ietf.org/rfc/rfc2046 "Multipurpose Internet Mail Extensions") [rfc2046](http://www.ietf.org/rfc/rfc2046 "Multipurpose Internet Mail Extensions"), [rfc3676](http://www.ietf.org/rfc/rfc3676 "The Text/Plain Format and DelSp Parameters") [rfc3676](http://www.ietf.org/rfc/rfc3676 "The Text/Plain Format and DelSp Parameters"), [rfc3023](http://www.ietf.org/rfc/rfc3023 "XML Media Types") [rfc3023](http://www.ietf.org/rfc/rfc3023 "XML Media Types"), etc... - Provides **method-override** usign X-HTTP-Method-Override (Google recommendation) and/or using a query-param (customisable). - Supports **content negotiation** (which can also be overriden). - Take advantages of network caches -- supports HEAD test. - Available as a standalone **[PHAR](http://api.ouarz.net/v1/download/apix.phar "Download the Phar file.")** file, or via **[Composer](https://packagist.org/packages/apix/apix "Composer (TODO add to composer)")** or as a **[PEAR](http://pear.ouarz.net "PEAR (TODO add to OUARZ)") [pear](http://pear.ouarz.net "PEAR (TODO add to OUARZ)")** package. - Continuous integration against PHP **5.x**, and **7.x**. - Read the [documentation](http://apix.readthedocs.org/en/latest/ "APIx Official Documentaion.")! Todo: - Self-generated API resources testing. - Add support for WSDL 2.0 / WADL. - Eventually SOAP (and XML\_RPC) bridging. Feel free to comment, send pull requests and patches... Basic usage ----------- [](#basic-usage) ```