README

Phalcon REST

Library for enhancing Micro applications with REST functionality, Bearer Token Parsing, and JSON Interpretation. Includes Dynamic Validation Processing to make JWT extensible. This is not a fully baked Micro Application, but rather a set of tools to enable additional out-of-the-box functionality for your own micro applications.

Explore the docs »

Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Installation
• Implementing a Service
• Sections
  • Tools
  • JSON Headers
  • JWT Encryption
  • Middleware
• Roadmap
• Contributing
• License
• Contact

About The Project

Built With

• vscode
• Postman
• php 8.1.1
• Phalcon 5 (Micro Framework)

Installation

Git:

git clone https://github.com/SageITSolutions/phalcon-rest.git

Composer:

composer require sageit/phalcon-rest

Implementing a Service

This project consists of prebuild services that simply need to be added to DI for services. JWT assumes the presense of a config object in the DI with a JWT section. This can also be passed as a named array in the constructor, but the provided JWT service does not utilize this.

Config Register

One option is to have your application iterate services listed in the config object and register them

services:
  tools: Phalcon\Di\Service\Common\Tools
  request: Phalcon\Di\Service\Request\Json
  response: Phalcon\Di\Service\Response\Json
  jwt: Phalcon\Di\Service\Encryption\Security\JWT\Jwt

foreach ($config->services as $service => $class) {
  $di->register(new $class);
}

Register Manually

$di->register(new \Phalcon\Di\Service\Common\Tools());
$di->register(new \Phalcon\Di\Service\Request\Json());
$di->register(new \Phalcon\Di\Service\Response\Json());
$di->register(new \Phalcon\Di\Service\Encryption\Security\JWT\Jwt());

Sections

• Tools
• JSON Headers
• JWT Encryption
• Middleware

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Sage IT Solutions - Email

Project Link: https://github.com/SageITSolutions/phalcon-rest