mhetreramesh / php-clean-code-api

PHP clean code architecture using design principles

PHP clean code architecture example

Requirements

1. Create recipies API without using any framework but can use packages
2. Use clean code concepts while building architecture
3. Document API's very well

Basic Details & instructions

• Since I had some other serivce running on 80 port, I've made chage in docker-compose.yml to run nginx on 82 port, so the application will be accessible on http://localhost:82 url. You can find it on develop branch.
• Composer Install - If you have composer installed on your local you can directly do composer install else can use my docker image script cd web && bash composer_update.sh.
• DB Migrations - Short command bash migrate.sh or ssh into php container & run phpmig migrate command
• Unit Test - To Run Unit tests use composer test or use bash phpunit.sh
• API DOC - You can access swagger API doc on http://localhost:82/doc/index.html URL
• GET API with search, pagination all in this eample - http://localhost:82/recipes?search=K&orderBy=id&orderDirection=desc&offset=0&limit=3

Clean code architecture

• I've followed Clean Code Architecture in PHP by Kristopher Wilson. (A free version)
• Bellow are few concepts I've focused & followed while building this architecture
  • SOLID Principles
  • The Onion Architecture
  • Factory Pattern & Static Factories
  • Adapter Pattern
  • Repository Pattern
• The main benefit of having this kind of architecture is to keep your core business logic testable

Resources/plugins used

• patricklouys/http - Simple, independent HTTP component
• nikic/fast-route - Simple, minimal & fast request router in PHP
• rdlowrey/auryn - A dependency injector for bootstrapping object-oriented PHP applications
• filp/whoops - Error handling
• league/fractal - A package to handle data to make it ready for standard API output
• davedevelopment/phpmig - Simple database migration system in PHP
• gabordemooij/redbean - A micro ORM for PHP
• phpunit/phpunit - Testing framework

Directory Structure

• web - Everything related to business
  • core - The main business logic & persistance part
    • Adapter - Define rules using interfaces for business logic
    • Factory - The business logic access point for mediator
    • Service - Wrappers for third party plugins & applications
    • Usecase - A specefic business usecase will be coded here
  • migrations - All migrations and its log used phpmig package for that
  • public - Entry point of the project. Only this part is accessible to outside world
  • src - Mediator to serve the request & connect business logic & DB
  • tests - All tests written for the project. (Right now I've only written for /core/Usecases part)