renanhangai/libweb-api

LibWeb API part

3.0.1 2019-10-09 18:22 UTC

Requires

• dflydev/fig-cookies: ^1.0
• phpdocumentor/reflection-docblock: ^4.3
• slim/slim: ^3.9
• violet/streaming-json-encoder: ^1.1
• webmozart/path-util: ^2.3

Suggests

• maximebf/debugbar: Provides better debug functionality
• phpdocumentor/reflection-docblock: Better generation of docs
• renanhangai/validator: Includes validation for request parameters

MIT

• renanhangai

README

Generate REST APIs with ease using slim framework

<?php
$app = new \libweb\api\App;
$app->get( "/", function() { return "hello world"; });
$app->run();

Will output

{
	"status": "success",
	"data":   "hello world",
}

Methods

• mapClass( $base, $class )

  Ex:

   $app->mapClass( "/test", "\\test\\api\\Test" );

  Will be mapped to

   $obj = new \test\api\Test( $app );
  
   // "example.com/test/data"
   $obj->GET_data()
  
   // "example.com/test/info-name"
   $obj->GET_infoName()
  
   // "example.com/test/sub/dir/data"
   $obj->GET_sub_dir_data()
  
   // "example.com/test/sub-info/dir-name/data-user"
   $obj->GET_subInfo_dirName_dataUser()

• mapPath( $base, $dir, $classTemplate )

  Every path will be mapped to a file Ex:

   $app->mapPath( "/test", "/project/test/", "\\myproject\\api\\test{path}{class}API" );

  When entering to "example.com/test/user/books/data" Will be mapped to

   require_once "/project/test/user/Books.php";
   $obj = new \myproject\api\test\user\BooksAPI( $app );
   $obj->GET_data()

Request

Inherits from \Slim\Http\Request

• getValidatedParam( $name, $rule )
• getValidatedParams( $rules )

  $data = $req->getValidatedParams([
       "name" => v::s(),
       "list" => v::arrayOf([
           "id" => v::i(),
           "level?" => v::set(["N","R","W"]),
       ]),
   ]);

• getValidatedParamsWithUpload( $rules )

Response

Inherits from \Slim\Http\Response

• withFile( $file, $contentType = null )
• withString( $buffer, $contentType = null )
• withDownload( $file, $filename = null, $contentType = null, $mode = "attachment" )
• withDownloadString( $buffer, $filename, $contentType = null, $mode = "attachment" )
• withCookie( $key, $value, $options = array() )
• withCookies( $cookies, $options = array() )
• withJson( $data, $status = null )
• withResponse( $data )