Download the PHP package diomac/php-api-rest without Composer

PHP-API-REST

PHP API REST framework using annotations, and Swagger 2.0 support.

Prerequisites

• PHP >=7.2

Optional (Recommended)

Caching routes

• nrk/predis (Redis) - https://github.com/nrk/predis Or
• Pecl APC - Alternative PHP Cache - https://pecl.php.net/package/apc

Swagger yaml format

• yaml pecl extension https://pecl.php.net/package/yaml

Installing

Use composer to manage your dependencies and download PHP-API-REST:

Get Started

API Rest Configuration

• 1 - Place an .htaccess file in the root folder of your Rest API (base url), to redirect all routes to the API initialization file.

Example API folders:

.htaccess file:

• 2 - Use the initialization file to import the dependencies of your project and...
  • Instantiate a Diomac\API\AppConfiguration object;
  • Set the base url of your API;
  • Add the Resources Class Names of your API (See Implementing API Rest Resources);
  • Instantiate a Diomac\API\App object using the configuration object;
  • Finally call exec method.

init.php file:

Implementing API Rest Resources

• 3 - In the resource class, enter the inheritance of the Resource class:

• 4 - For each method of the resource class, enter PHP annotation to identify routes (@route), HTTP methods (@method) and if you need a Class implementing Guard Interface to protect the route (@guard - See how implement guards in topic Implementing a Guard Class ):

Resource Class Inheritance

• 5 - Whenever a route is executed, the class holding the route will be instantiated and inherit the following attributes:

A Diomac\API\Request object with the methods:

A Diomac\API\Response object with the methods:

And it inherits methods from the Diomac\API\Resource class:

Output

• 6 - For the output simply return the response object:

Complete Resource example

API get method:

Guards

Implementing a Guard Class

Cache

Cache settings save the mapped routes into a list, and when used (set to true), skip the route mapping step for better performance.

Cache with APC - Alternative PHP Cache

Cache with Redis

Swagger 2.0 support

swagger.json or swagger.yaml

Create a route in a resource like the example below:

PHP Class:

Route result:

Swagger Info

To document the information (Swagger Info) of your API, you can use Swagger and SwaggerInfo classes. Just implement an "ExampleSwaggerDoc" class that inherits from Swagger as in the example below:

PHP Class:

@tag

Use @tag in PHPDoc Class to document Resources's routes with Swagger Tag Object.

PHPDoc:

Swagger json result:

@tag (string)

Use @tag in PHPDoc function to document your route with a additional tag.

PHPDoc:

Swagger json result:

@contentType

Use @contentType in PHPDoc function to document your route with Swagger produces [string].

PHPDoc:

Swagger json result:

@summary

Use @summary in PHPDoc function to document your route with Swagger summary string.

PHPDoc:

Swagger json result:

@description

Use @description in PHPDoc function to document your route with Swagger description string.

PHPDoc:

Swagger json result:

@operationId

Use @operationId in PHPDoc function to document your route with Swagger operationId string.

PHPDoc:

Swagger json result:

@consumeType

Use @consumeType in PHPDoc function to document your route with Swagger consumes [string].

PHPDoc:

Swagger json result:

@response(...)

Use @response(...) in PHPDoc function to document your route with Swagger response object.

PHPDoc:

Swagger json result:

License

This project is licensed under the MIT License - see the LICENSE file for details