Download the PHP package chez14/f3-api without Composer
On this page you can find all versions of the php package chez14/f3-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download chez14/f3-api
More information about chez14/f3-api
Files in chez14/f3-api
Package f3-api
Short Description FatFree Framework API Boilerplate
License LGPL-3.0-or-later
Informations about the package f3-api
Fat-free API Boilerplate
Fat-free framework API Boilerplate to make your life easier.
I really love to make APIs so here's my basic API Standard. Heavily inspired by Facebook API and my senpai's standard.
Installed Instance:
- Fat-free for the cure core of this boilerplate.
- Cortex for modelling (you could remove it easily, please see our manual (soon))
- Ilgar for easy migrations.
Features
Better output standards. the app/output/formatter.php
are responsible to make your outputs beautiful.
It's designed to be easily changed. The app/view/api.php
are the one responsible to choose whether it's XML or JSON output.
API Standards
Method | URL | Controller | Description |
---|---|---|---|
GET | /@module/@func(.json | .xml | null ) |
Controller\@module->get_@func | Usually i get listings of things by this method. |
POST | /@module/@func(.json | .xml | null ) |
Controller\@module->post_@func | Usually i create object with this. |
PUT (POST-like) | /@module/@func(.json | .xml | null ) |
Controller\@module->put_@func | I update things here. |
DELETE | /@module/@func(.json | .xml | null ) |
Controller\@module->delete_@func | I delete things here. |
NOTE: The @func
is optional. When access GET /@module
, it will invoke Controller\@module->get_index
and etc. So it's important to know how todo things.
NOTE: Oh the future, i'll add the Authorization
header required for API Key and etcs. Please bear with us.
SPECIAL: You just need to add ?json_pretty_print
on the end of the URL if you wanted to pretty print the JSON. Have fun!
WARNING: When the extension is not defined, we'll treat them as JSON.
Getting Started
-
Invoke this:
-
Do your own setup on
app/config/
find for
.example.ini
file, and change them as your system setups. -
Run the development server:
-
Run a migration
You can access
http://localhost:8080/-/migrate
to start the migration.
License
GPLv3.
All versions of f3-api with dependencies
spatie/array-to-xml Version ^2.8
ikkez/f3-cortex Version ^1.5
chez14/f3-ilgar Version v1.0.0.1