PHP Microservices Framework: Setup microservices apps with configuration arrays

Recommend this page to a friend!

Download

Info

Documentation

Screenshots

Files

Install with Composer

Download

Reputation

Support forum

Blog

Links

Last Updated		Ratings				Unique User Downloads		Download Rankings
2026-03-17 (13 days ago)		Not enough user ratings				Total: 147		All time: 9,125 This week: 40

Version		License		PHP version		Categories
`microservices` 5.66		MIT/X Consortium ...		7.4		Design Patterns, PHP 7

Description

Author

Ramesh Narayan Jangid (Sharma)

This package can be used to setup microservices apps using configuration arrays.

It can read configuration PHP scripts that contain values that will be used to set up details of operation of an application based on microservices.

Currently it allows to configure:

- SQL query templates to perform CRUD operations on data stored in a database

- Scripts that should handle HTTP requests of methods GET, POST, DELETE, PATCH and PUT

Innovation Award

April 2023
Winner

Many PHP applications are based in microservices that implement Web or API interfaces.

These applications can be implemented using base core code that developers can customize in several ways.

This package implements a microservices approach based on configuration PHP scripts that contain arrays with values to set the application's behavior.

This way, it is straightforward and fast to create microservices-based applications.

Manuel Lemos

Ramesh Narayan Jangid ...

Performance

Level

Name:	Ramesh Narayan Jangid ... `<contact>`
Classes:	11 packages by Ramesh Narayan Jangid ...
Country:	India

Level 1

Innovation award

Nominee: 5x

Winner: 4x

Recommendations

Online examination system for staff recruitment
Web based Online examination system for staff recruitment

Instructions

import global.sql in global database import cache.sql in cache database import client_master.sql in client_001 database

Make required config changes in .env.example

HttpAuthenticationRestrictedIp='127.0.0.1' HttpAuthenticationUser='reload_username' HttpAuthenticationPassword='reload_password'

cacheHostname='127.0.0.1' cachePort=3306 cacheUsername='root' cachePassword='shames11'

defaultDbHostname='127.0.0.1' defaultDbPort=3306 defaultDbUsername='root' defaultDbPassword='shames11'

Save .env.example as .env

Open a browser and access below once to complete with setting-up things. http://localhost/Microservices/public_html/index.php?r=/reload Make required changes as per Microservices folder path. Username/Password: reload_username/reload_password

Ready to go !

Open Postname and try requesting for access token. http://localhost/Microservices/public_html/index.php?r=/login admin/shames11 client_1_user_1/shames11

Documentation

PHP low code API generator

This is a light & easy low code API generator using configuration arrays. It can be used to create API's in very short time once you are done with your database.

.env File

Configuration Rules

Rules For Custom DataTypes Configuration
Rules For Route Configuration
Rules For SQL Configuration
Rules For Payload Formats
Rules For TestCase Configuration

JavaScript Examples

JavaScript Examples

SQL File

Sql/global.sql Import this SQL file on your MySql global instance
Sql/customer\_master.sql Import this SQL file on your MySql customer instance
Note: One can import both sql's in a single database to start with. Just configure the same details in the environment files.

Folders

File Folder

Log Folder for application Log.
TestCase Folder for Test Cases

www Folder

Config Basic configuration folder
File Folder for uploaded files.
Hook Hook.
Supplement Customised coding for APIs
Validation Contains validation classes.
public\_html Contains index.php file.

www/File Folder

Dropbox/Open Uploaded files for open to web
Dropbox/Closed Uploaded files by authorised user
ServingFile/HTML HTML files to be served with dynamic response (XSLT)
ServingFile/PHP PHP view files to be served with dynamic response
ServingFile/XSLT XSLT files to be served with dynamic response

www/Supplement Folder

Crons Contains classes for cron API's
Custom Contains classes for custom API's
ThirdParty Contains classes for third-party API's
Upload Contains classes for upload file API's

Route Folder

www/Config/Route

/Config/Route/Auth/<GroupName>
/Config/Route/Open
<GroupName> is the group user belongs to for accessing the API's

File

/GETroutes.php for all GET method routes configuration.
/POSTroutes.php for all POST method routes configuration.
/PUTroutes.php for all PUT method routes configuration.
/PATCHroutes.php for all PATCH method routes configuration.
/DELETEroutes.php for all DELETE method routes configuration.

Sql Folder

These files locations are used in routes config to be used for generating response.

www/Config/Sql

/Config/Sql/Auth/GlobalDB for global database.
/Config/Sql/Auth/CustomerDB for customer (including all hosts and their databases).
/Config/Sql/Open for Open to Web API's (No Authentication).

File

/GET/<filenames>.php GET method SQL.
/POST/<filenames>;.php POST method SQL.
/PUT/<filenames>.php PUT method SQL.
/PATCH/<filenames>.php PATCH method SQL.
/DELETE/<filenames>.php DELETE method SQL.

One can replace <filenames> tag with desired name as per functionality.

Contributing

Issues and feature request are welcome.<br /> Feel free to share them on issues page

Author

Ramesh N. Jangid (Sharma)

Github: @polygoncoin

License

Screenshots (3)

Files (305)

File	Role	Description
`App` (34 files, 6 directories)
`Sql` (2 files)
`TestCase` (6 files, 2 directories)
`www` (6 directories)
`.env.cidr.example`	Data	Auxiliary data
`.env.customer.container.example`	Data	Auxiliary data
`.env.enable.example`	Data	Auxiliary data
`.env.example`	Data	Auxiliary data
`.env.global.container.example`	Data	Auxiliary data
`.env.rateLimiting.example`	Data	Auxiliary data
`.env.session.example`	Data	Auxiliary data
`Autoload.php`	Class	Class source
`Env.cidr.example.md`	Data	Auxiliary data
`Env.customer.container.example.md`	Data	Auxiliary data
`Env.enable.example.md`	Data	Auxiliary data
`Env.example.md`	Data	Auxiliary data
`Env.global.container.example.md`	Data	Auxiliary data
`Env.rateLimiting.example.md`	Data	Auxiliary data
`Env.session.example.md`	Data	Auxiliary data
`License`	Lic.	License text
`Microservices-JavaScript-Examples.md`	Data	Auxiliary data
`README.md`	Doc.	Example script
`Rules-For-Custom-D...es-Configuration.md`	Data	Auxiliary data
`Rules-For-Payload-Formats.md`	Data	Auxiliary data
`Rules-For-Routes-Configuration.md`	Data	Auxiliary data
`Rules-For-SQL-Configuration.md`	Data	Auxiliary data
`Rules-For-TestCases-Configuration.md`	Data	Auxiliary data

File	Role	Description
`DataRepresentation` (2 files, 2 directories)
`DropboxHandler` (1 file)
`Export` (2 files, 1 directory)
`Middleware` (1 file)
`Server` (3 files, 4 directories)
`SessionHandler` (2 files, 1 directory)
`Api.php`	Class	Class source
`AppTrait.php`	Class	Class source
`CacheServerKey.php`	Class	Class source
`CommonFunction.php`	Class	Class source
`Constant.php`	Class	Class source
`Counter.php`	Class	Class source
`Cron.php`	Class	Class source
`Custom.php`	Class	Class source
`DatabaseServerDataType.php`	Class	Class source
`DbCommonFunction.php`	Class	Class source
`Dropbox.php`	Class	Class source
`Env.php`	Class	Class source
`Export.php`	Class	Class source
`Gateway.php`	Class	Class source
`Hook.php`	Class	Class source
`Http.php`	Class	Class source
`HttpRequest.php`	Class	Class source
`HttpResponse.php`	Class	Class source
`HttpStatus.php`	Class	Class source
`Log.php`	Class	Class source
`Login.php`	Class	Class source
`Microservices.php`	Class	Class source
`QueryCacheServerKey.php`	Class	Class source
`RateLimiter.php`	Class	Class source
`Read.php`	Class	Class source
`Reload.php`	Class	Class source
`Route.php`	Class	Class source
`RouteParser.php`	Class	Class source
`Start.php`	Class	Class source
`Supplement.php`	Class	Class source
`ThirdParty.php`	Class	Class source
`Upload.php`	Class	Class source
`Validator.php`	Class	Class source
`Write.php`	Class	Class source

File	Role	Description
`Decode` (3 files, 1 directory)
`Encode` (4 files, 3 directories)
`DataDecode.php`	Class	Class source
`DataEncode.php`	Class	Class source

File	Role	Description
`JsonDecode` (2 files)
`DataDecodeInterface.php`	Class	Class source
`JsonDecode.php`	Class	Class source
`XmlDecode.php`	Class	Class source

File	Role	Description
`JsonDecodeEngine.php`	Class	Class source
`JsonDecodeObject.php`	Class	Class source

File	Role	Description
`JsonEncoder` (1 file)
`PhpEncoder` (1 file)
`XmlEncoder` (1 file)
`DataEncodeInterface.php`	Class	Class source
`JsonEncode.php`	Class	Class source
`PhpEncode.php`	Class	Class source
`XmlEncode.php`	Class	Class source

File	Role	Description
`Container` (1 file)
`ExportDatabaseServer.php`	Class	Class source
`ExportDatabaseServerInterface.php`	Class	Class source

File	Role	Description
`CacheServer` (4 files)
`Container` (2 directories)
`DatabaseServer` (3 files)
`QueryCacheServer` (6 files)
`CacheServer.php`	Class	Class source
`DatabaseServer.php`	Class	Class source
`QueryCacheServer.php`	Class	Class source

File	Role	Description
`CacheServerInterface.php`	Class	Class source
`MemcachedCache.php`	Class	Class source
`MongoDbCache.php`	Class	Class source
`RedisCache.php`	Class	Class source

File	Role	Description
`Memcached.php`	Class	Class source
`MongoDb.php`	Class	Class source
`NoSqlInterface.php`	Class	Class source
`Redis.php`	Class	Class source

File	Role	Description
`MySql.php`	Class	Class source
`PostgreSql.php`	Class	Class source
`SqlInterface.php`	Class	Class source

File	Role	Description
`DatabaseServerInterface.php`	Class	Class source
`MySqlDatabase.php`	Class	Class source
`PostgreSqlDatabase.php`	Class	Class source

File	Role	Description
`MemcachedQueryCache.php`	Class	Class source
`MongoDbQueryCache.php`	Class	Class source
`MySqlQueryCache.php`	Class	Class source
`PostgreSqlQueryCache.php`	Class	Class source
`QueryCacheServerInterface.php`	Class	Class source
`RedisQueryCache.php`	Class	Class source

File	Role	Description
`Container` (9 files)
`CustomSessionHandler.php`	Class	Class source
`Session.php`	Class	Class source

File	Role	Description
`CookieBasedSessionContainer.php`	Class	Class source
`FileBasedSessionContainer.php`	Class	Class source
`MemcachedBasedSessionContainer.php`	Class	Class source
`MongoDbBasedSessionContainer.php`	Class	Class source
`MySqlBasedSessionContainer.php`	Class	Class source
`PostgreSqlBasedSessionContainer.php`	Class	Class source
`RedisBasedSessionContainer.php`	Class	Class source
`SessionContainerHelper.php`	Class	Class source
`SessionContainerInterface.php`	Class	Class source

File	Role	Description
`customer_master.sql`	Data	Auxiliary data
`global.sql`	Data	Auxiliary data

File	Role	Description
`Auth` (5 directories)
`Open` (2 directories)
`AuthTest.php`	Aux.	Configuration script
`category.csv`	Data	Auxiliary data
`OpenTest.php`	Aux.	Configuration script
`OpenTestXml.php`	Aux.	Configuration script
`SupplementTest.php`	Aux.	Configuration script
`Test.php`	Class	Class source

File	Role	Description
`DELETE` (4 files)
`GET` (11 files)
`PATCH` (3 files)
`POST` (8 files)
`PUT` (3 files)

File	Role	Description
`Address.php`	Aux.	Configuration script
`CategoryTruncate.php`	Aux.	Configuration script
`Registration.php`	Aux.	Configuration script
`RegistrationWithAddress.php`	Aux.	Configuration script

File	Role	Description
`Category.php`	Aux.	Configuration script
`CategoryOrderBy.php`	Aux.	Configuration script
`CategorySingle.php`	Aux.	Configuration script
`Route.php`	Aux.	Configuration script

File	Role	Description
`Config` (2 directories)
`File` (1 directory)
`Hook` (3 files)
`public_html` (1 file)
`Supplement` (5 directories)
`Validation` (4 files)

File	Role	Description
`Common` (5 files, 4 directories)
`Groups` (3 directories)

File	Role	Description
`Cron` (5 files)
`Custom` (5 files)
`ThirdParty` (5 files)
`Upload` (5 files)
`DELETEroutes.php`	Aux.	Configuration script
`GETroutes.php`	Aux.	Configuration script
`PATCHroutes.php`	Aux.	Configuration script
`POSTroutes.php`	Aux.	Configuration script
`PUTroutes.php`	Aux.	Configuration script

File	Role	Description
`AdminGroup` (5 files)
`Customer001UserGroup1` (5 files)
`Customer001UserGroup2` (5 files)

File	Role	Description
`DELETE` (4 files)
`GET` (9 files)
`PATCH` (3 files)
`POST` (4 files)
`PUT` (3 files)

File	Role	Description
`Address-all.php`	Aux.	Configuration script
`Address-single.php`	Aux.	Configuration script
`Category-all.php`	Example	Example script
`Category-search.php`	Aux.	Configuration script
`Category-single.php`	Aux.	Configuration script
`Registration-all.php`	Example	Example script
`Registration-single.php`	Example	Example script
`Registration-With-Address-all.php`	Example	Example script
`Registration-With-Address-single.php`	Example	Example script

File	Role	Description
`Common` (1 file)
`DELETE` (2 files)
`GET` (2 files)
`PATCH` (2 files, 3 directories)
`POST` (2 files)
`PUT` (2 files)

File	Role	Description
`customer.php`	Aux.	Configuration script
`groups.php`	Aux.	Configuration script

File	Role	Description
`approve` (2 files)
`disable` (2 files)
`enable` (2 files)
`customer.php`	Aux.	Configuration script
`groups.php`	Aux.	Configuration script

File	Role	Description
`Registration-With-Address.php`	Example	Example script
`Registration.php`	Example	Example script

File	Role	Description
`HookInterface.php`	Class	Class source
`HookTrait.php`	Class	Class source
`Hook_Example.php`	Class	Class source