Url Shortener based on Slim Framework 3

Prerequisites

1. PHP >= 7.1
2. Composer installed for managing PHP Dependencies
3. Git for accessing GitHub

Install the Application

Step 1: Clone the project

git clone https://github.com/asenlog/url-shortener.git

Step 2: Install Dependencies

compose install

Step 3: Running Tests

composer test

Run the Application

Step 1: Start PHP Server

composer start

Step 2: Navigate to API Description (swagger.json)

Open on your Browser http://localhost:8080/swagger

Application Design

The Url Shortener is built using the Slim framework, managing project dependencies with composer and implementing the MVC and Strategy pattern. Dependency Injection (based on Pimple) has been used to manage the dependencies and lazy loading. The application is following PSR-2 coding standards.

Analytically
Used Controller to get the request parameters and dynamically (through a service registering which provider to use that gets the provider name from the request) to select which provider to use.
The Validation is taking place inside the middleware and the default http Errors have been overwritten to always respond with json. Lastly a swagger.json is provided as documentation for this API.

Application Structure

- config
--- dependencies [All Services Used are declared here.]
--- errorHandlers [Overrides the default error handlers to produce custom responses.]
--- middleware [Used to validate the headers and parameters for the incoming request.]
--- routes [API Routes.]
--- settings [Keeps all the projects settings.]
- logs [Applications logs]
- src
--- CacheProviders [Holds the Cache providers (For now only a File Cache Provider)]
--- Constants [Holds all the Const Variables used across all the project as a central point of reference] 
--- Controllers [Default Controller that holds the route]
--- Interfaces [Interfaces Used for the Providers]
--- Models [Model of the incoming request] 
--- Providers [The 2 providers currently used Bitly and Rebrandly] 
--- Services [Contains the Shortening Service and the Validator Service Used]
- tests [Application Tests with PHPUnit]