PHPackages                             llwebsol/rapid - 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. [API Development](/categories/api)
4. /
5. llwebsol/rapid

ActiveLibrary[API Development](/categories/api)

llwebsol/rapid
==============

A simple and minimalist framework for php APIs

v3.0.0(6y ago)193MITPHPPHP ^7.1.0CI failing

Since Jan 29Pushed 6y ago3 watchersCompare

[ Source](https://github.com/llwebsol/rAPId)[ Packagist](https://packagist.org/packages/llwebsol/rapid)[ RSS](/packages/llwebsol-rapid/feed)WikiDiscussions master Synced 4d ago

READMEChangelog (9)Dependencies (3)Versions (12)Used By (0)

[![Build Status](https://camo.githubusercontent.com/a45b26853702a4b1245626c1c0da6dcaa11202595628c0d1a41048b2c5899382/68747470733a2f2f7472617669732d63692e6f72672f6c6c776562736f6c2f72415049642e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/llwebsol/rAPId)[![Latest Stable Version](https://camo.githubusercontent.com/c8ff8f0a7296f62da745394d3c1a5710bb139eb03d8485cdf4a23cd838b37992/68747470733a2f2f706f7365722e707567782e6f72672f6c6c776562736f6c2f72617069642f762f737461626c65)](https://packagist.org/packages/llwebsol/rapid)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/c57b1d6eaad3f478f7714ab7704a458760054b96f42b9ecef202dd268786fcd2/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6c6c776562736f6c2f72415049642f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/llwebsol/rAPId/?branch=master)[![Code Intelligence Status](https://camo.githubusercontent.com/81c65831aea75311c5c835f11e6503f656dada544384a45dea007f4cd7b907b2/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6c6c776562736f6c2f72415049642f6261646765732f636f64652d696e74656c6c6967656e63652e7376673f623d6d6173746572)](https://scrutinizer-ci.com/code-intelligence)

[![Total Downloads](https://camo.githubusercontent.com/d04efefd10ee7bb4535dc130371e84065831c84d1322c481c3b594ae10e4a817/68747470733a2f2f706f7365722e707567782e6f72672f6c6c776562736f6c2f72617069642f646f776e6c6f616473)](https://packagist.org/packages/llwebsol/rapid)[![License](https://camo.githubusercontent.com/b6379413b56142a59ee7f347175052bc89e748388e7d280a8f9894708168dd85/68747470733a2f2f706f7365722e707567782e6f72672f6c6c776562736f6c2f72617069642f6c6963656e7365)](https://packagist.org/packages/llwebsol/rapid)

rAPId
=====

[](#rapid)

a simple and minimalist framework for php APIs

Getting Started
---------------

[](#getting-started)

To create a project called `YourProject`:

1. Create an empty directory for your project and cd into it
2. set up your project with `$ composer init` [requires composer](https://getcomposer.org/download/).
3. Add to your composer.json

```
    "require": {
        "llwebsol/rapid": "^3.0"
    },

    "scripts": {
        "post-update-cmd": "vendor/bin/rAPId"
    },

    "autoload": {
        "psr-4": {
            "YourProject\\": "src/"
        }
    }

```

Now run `composer update` and the necessary files should be automatically added to your projects root directory.

### Docker

[](#docker)

a default Dockerfile and docker-compose.yml will have been added to your root directory. You may edit these as needed, or spin up the default Docker environment with `docker-compose up`. Your app will be available on `localhost:5000`

### Controllers

[](#controllers)

Add a new file to the new `Controllers` directory that was added (it may be in src/Controllers)

#### Example default controller

[](#example-default-controller)

**(src/Controllers/Main.php)**:

```