Skip to content

Repository files navigation

KAPI: Doors for PHP - v1.0.0

Build Status

Slim Framework based simple helper to generate RESTful API's and applications, requires PHP 7.

KAPI means "door" in Turkish.

Creating a Project skeleton

git clone https://github.com/emir/kapi myproject
cd myproject
composer install

It will create an example project.

Edit Configuration

$EDITOR .env

Migrations

phinx migrate

Running the Project

cd myproject
php -S localhost:8080 -t public

That's all! :)

Getting Started

You should define your URLs in routes.php:

# src/routes.php<?php$urls = [
['get', '/books', 'BooksController::index', 'List all books.']
];

Create your models:

# src/Models/Book.php<?phpnamespaceApp\Models;
useIlluminate\Database\Eloquent\Model;
class Book extends Model
{
/** * @var array */protected$guarded = [];
}

Create your Controllers and methods:

# src/Controllers/BooksController.php<?phpnamespaceApp\Controllers;
useApp\Models\Book;
useIlluminate\Database\Eloquent\ModelNotFoundException;
useIlluminate\Database\QueryException;
useSlim\Http\Request;
useSlim\Http\Response;
class BooksController extends AbstractController
{
/** * @param Request $request * @param Response $response * @return Response */publicfunctionindex(Request$request, Response$response): Response
{
$books = Book::all();
return$response->withJson($books);
}
}

Done!

About

Slim Framework based simple helper to generate RESTful API's and applications, requires PHP 7.

Resources

Contributing

Stars

180 stars

Watchers

14 watching

Forks

Releases

Packages

Used by

Contributors

Languages