PHP API Tutorial Training Server: Implementation of a REST API for learning purposes

Recommend this page to a friend!

Download

Info

Example

Files

Install with Composer

Download

Reputation

Support forum

Blog

Links

Ratings				Unique User Downloads		Download Rankings
Not yet rated by the users				Total: 136		All time: 9,277 This week: 55

Version		License		PHP version		Categories
`training-server` 1.0.0		MIT/X Consortium ...		5		HTTP, PHP 5, Libraries, Web services

Description

Author

Kamil

This package provides an implementation of a REST API for learning purposes.

It provides all the files to implement an API using REST HTTP requests, including user authentication using OAuth.

The package provides an API example implementation endpoints to demonstrate features like registered user access, setting cookies in the API responses, and retrieving file data as responses.

It also provides files to set up a Docker container to test the provided API.

Innovation Award

September 2021
Number 3

Creating an API can be a complex process. Depending on what you want the API to do, you may need to implement other features besides the actual API function.

For instance, you may need to implement API user management and customize the API responses to address the API user's needs better.

This package provides a solution to allow you to train yourself in API creation.

You can set up a Docker container to create a closed environment specifically to test the APIs you will make.

Manuel Lemos

Kamil

Performance

Level

Level 1

Innovation award

Nominee: 1x

Example


<?php



/*

|--------------------------------------------------------------------------

| API Routes

|--------------------------------------------------------------------------

|

| Here is where you can register API routes for your application. These

| routes are loaded by the RouteServiceProvider within a group which

| is assigned the "api" middleware group. Enjoy building your API!

|

*/



Route::get('basic-auth', function(){

    return response()

        ->json([

            'status' => 'ok',

        ]);

})->middleware('auth.basic.once');





Route::get('plain/users', function() {

    return response()

        ->json(\DB::table('users')->select()->limit(20)->get());

});



Route::get('plain/cookies', function() {

    return response('ok')

        ->cookie('test', 'value', 10)

        ->cookie('another', 'cookie', 10);

});



Route::get('oauth2/users', function(){



    return response()

        ->json(\DB::table('users')->select()->limit(20)->get());



})->middleware('auth:api');



Route::get('plain/files/{type}', function($type) {



    $types = [

        'csv' => 'text/csv',

        'css' => 'text/css',

        'js'  => 'text/javascript',

        'png' => 'image/png',

    ];



    if(!isset($types[$type])) {

        throw new \Symfony\Component\HttpKernel\Exception\NotFoundHttpException();

    }



    return response()->download(

        base_path() . '/resources/assets/sample-files/sample.' . $type,

        'sample.' .  $type,

        [

            'Content-Type' => array_get($types, $type),

        ]

    );

});

Details

Training server for RestControl

TrainingServer contains several REST endpoints e.q. with oAuth/basic authentication, which you can use for learning RestControl.

Installation

 make build
 make first-run

Start server

 make start

Usage

 # Run all tests
 make run-tests

Endpoints

-> Plain api(without any authorization)

(GET) http://IP_ADDR/plain/users

Sample response:

[
  [
      "id": 1,
      "name": "Sample name",
      "email": "sample@email.com",
      "password": "sample_long_password_string",
      "remember_token": null,
      "created_at": "2018-01-01 10:00:00",
      "updated_at": "2018-01-01 10:00:00",
  ],
  [
      "id": 2,
      "name": "Sample name",
      "email": "another@email.com",
      "password": "sample_long_password_string",
      "remember_token": null,
      "created_at": "2018-01-01 10:00:00",
      "updated_at": "2018-01-01 10:00:00",
  ],
]

(GET) http://ID_ADDR/plain/files/csv (GET) http://ID_ADDR/plain/files/css (GET) http://ID_ADDR/plain/files/js (GET) http://ID_ADDR/plain/files/png (GET) http://ID_ADDR/plain/cookies

-> Basic auth

(GET) http://IP_ADDR/basi-auth

Sample response:

 [
    "status": "ok"
 ]

-> oAuth2 Endpoints

(POST) http://IP_ADDR/oauth2/token

> Form params: > - grant_type(optional): password, client_credentials > - client_id: string > - client_secret: string > - username: string > - password: string > - scope(optional): string > > Seeds: > - Password grant client > - client_id: 10 > - client_secret: F0NVue12qNwayx3pKJLHfJmQouOZg40YZafjjdHZ

(GET) http://ID_ADDR/oauth2/users - Return list of users.

>Headers: > - Content-Type: application/json > - Authorization: Bearer ACCESS_TOKEN > >

Sample response:

[
  [
      "id": 1,
      "name": "Sample name",
      "email": "sample@email.com",
      "password": "sample_long_password_string",
      "remember_token": null,
      "created_at": "2018-01-01 10:00:00",
      "updated_at": "2018-01-01 10:00:00",
  ],
  [
      "id": 2,
      "name": "Sample name",
      "email": "another@email.com",
      "password": "sample_long_password_string",
      "remember_token": null,
      "created_at": "2018-01-01 10:00:00",
      "updated_at": "2018-01-01 10:00:00",
  ],
]

Files (87)

File	Role	Description
`Docker` (5 files)
`server` (9 files, 7 directories)
`tests` (2 files, 1 directory)
`LICENSE`	Lic.	License text
`Makefile`	Data	Auxiliary data
`README.md`	Doc.	Documentation

File	Role	Description
`cli.docker`	Data	Auxiliary data
`docker.yml`	Data	Auxiliary data
`fpm.docker`	Data	Auxiliary data
`mysite.template`	Data	Auxiliary data
`nginx.docker`	Data	Auxiliary data

File	Role	Description
`app` (1 file, 4 directories)
`bootstrap` (1 file)
`config` (13 files)
`database` (3 directories)
`public` (3 files, 2 directories)
`resources` (4 directories)
`routes` (3 files)
`.env`	Data	Auxiliary data
`.env.example`	Data	Auxiliary data
`artisan`	Class	Class source
`composer.json`	Data	Auxiliary data
`package.json`	Data	Auxiliary data
`phpunit.xml`	Data	Auxiliary data
`server.php`	Aux.	Auxiliary script
`webpack.mix.js`	Data	Auxiliary data
`yarn.lock`	Data	Auxiliary data

File	Role	Description
`Console` (1 file)
`Exceptions` (1 file)
`Http` (1 file, 1 directory)
`Providers` (5 files)
`User.php`	Class	Class source

File	Role	Description
`Kernel.php`	Class	Class source

File	Role	Description
`Handler.php`	Class	Class source

File	Role	Description
`Middleware` (6 files)
`Kernel.php`	Class	Class source

File	Role	Description
`AuthenticateOnceWithBasicAuth.php`	Class	Class source
`EncryptCookies.php`	Class	Class source
`RedirectIfAuthenticated.php`	Class	Class source
`TrimStrings.php`	Class	Class source
`TrustProxies.php`	Class	Class source
`VerifyCsrfToken.php`	Class	Class source

File	Role	Description
`AppServiceProvider.php`	Class	Class source
`AuthServiceProvider.php`	Class	Class source
`BroadcastServiceProvider.php`	Class	Class source
`EventServiceProvider.php`	Class	Class source
`RouteServiceProvider.php`	Class	Class source

File	Role	Description
`app.php`	Class	Class source

File	Role	Description
`app.php`	Class	Class source
`auth.php`	Class	Class source
`broadcasting.php`	Aux.	Auxiliary script
`cache.php`	Aux.	Auxiliary script
`database.php`	Aux.	Auxiliary script
`filesystems.php`	Aux.	Auxiliary script
`hashing.php`	Aux.	Auxiliary script
`logging.php`	Aux.	Auxiliary script
`mail.php`	Aux.	Auxiliary script
`queue.php`	Aux.	Auxiliary script
`services.php`	Class	Class source
`session.php`	Aux.	Auxiliary script
`view.php`	Aux.	Auxiliary script

File	Role	Description
`factories` (1 file)
`migrations` (1 file)
`seeds` (3 files)

File	Role	Description
`UserFactory.php`	Class	Class source

File	Role	Description
`2014_10_12_000000_create_users_table.php`	Class	Class source

File	Role	Description
`DatabaseSeeder.php`	Class	Class source
`OAuthSeeder.php`	Class	Class source
`UsersSeeder.php`	Class	Class source

File	Role	Description
`css` (1 file)
`js` (1 file)
`.htaccess`	Data	Auxiliary data
`index.php`	Class	Class source
`robots.txt`	Doc.	Documentation

File	Role	Description
`app.css`	Data	Auxiliary data

File	Role	Description
`app.js`	Data	Auxiliary data

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.

Install with Composer

	training-server-2021-09-11.zip 320KB
	training-server-2021-09-11.tar.gz 302KB
	Install with Composer

Version Control

Unique User Downloads

Download Rankings

100%

Total:	136
This week:	0

All time:	9,277
This week:	55

Applications that use this package

No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

About us

Advertise on this site

For more information send a message to info at phpclasses dot org.

File	Role	Description
`assets` (3 directories)
`csv` (1 file)
`lang` (1 directory)
`views` (1 file)

File	Role	Description
`js` (2 files, 1 directory)
`sample-files` (4 files)
`sass` (2 files)

File	Role	Description
`components` (1 file)
`app.js`	Data	Auxiliary data
`bootstrap.js`	Data	Auxiliary data

File	Role	Description
`sample.css`	Data	Auxiliary data
`sample.csv`	Data	Auxiliary data
`sample.js`	Data	Auxiliary data
`sample.png`	Icon	Icon image

File	Role	Description
`app.scss`	Data	Auxiliary data
`_variables.scss`	Data	Auxiliary data

File	Role	Description
`api.php`	Example	Example script
`channels.php`	Example	Example script
`console.php`	Example	Example script

File	Role	Description
`tests` (8 files, 2 directories)
`composer.json`	Data	Auxiliary data
`rest-control.yml`	Data	Auxiliary data

File	Role	Description
`Objects` (1 file)
`ServerResponses` (2 files)
`CookieTest.php`	Class	Class source
`ExpressionLanguageTest.php`	Class	Class source
`FilesTest.php`	Class	Class source
`HasItemsTest.php`	Class	Class source
`HasItemTest.php`	Class	Class source
`HttpBasicAuthTest.php`	Class	Class source
`HttpStatusCodesTest.php`	Class	Class source
`JsonPathTest.php`	Class	Class source

File	Role	Description
`GetUser.php`	Class	Class source
`GetUsers.php`	Class	Class source