reiterus/microapi-core

MicroApi Core is an ultra-lightweight, tiny engine based on Symfony packages.

1.3.3 2023-04-09 15:23 UTC

Requires

• php: ^8.1
• symfony/browser-kit: ^6.2
• symfony/config: ^6.2
• symfony/dependency-injection: ^6.2
• symfony/dotenv: ^6.2
• symfony/framework-bundle: ^6.2
• symfony/http-foundation: ^6.2
• symfony/http-kernel: ^6.2
• symfony/routing: ^6.2
• symfony/runtime: ^6.2
• symfony/yaml: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.16
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0

MIT

• Pavel Vasin

• symfony
• rest
• api
• engine
• microapi
• reiterus

README

MicroApi Core is an ultra-lightweight, tiny engine based on Symfony packages. It is intended for building small REST API applications. Since MicroApi is based on the Symfony architecture, it can be developed to any level of complexity if desired. Forming your application based on this engine, you will always be sure that there is nothing superfluous in your code.

Features of MicroApi Core out of the box:

• all endpoints are public
• loading all types of env files
• use of attributes
• only two configuration files
• use autoload_runtime.php
• minimum php version: 8.1
• Docker
• JSON response to an exception
• Makefile
• quality tools
  • PHP CS Fixer
  • PHPStan

Join the development of MicroApi!

Usage

It's very simple! Just run these two commands:

• composer create-project reiterus/microapi-core folder && cd folder
• make docker-start

That's all!
Now your API app is available at http://localhost:8008

Engine progress

• MicroApi Secure

Makefile commands

For the convenience of working with the project, there are several make-commands: local and for Docker.

See more...

Local

• make phpunit: run ./vendor/phpunit/phpunit/phpunit
• make phpfixer: run ./vendor/bin/php-cs-fixer fix
• make phpstan: run ./vendor/bin/phpstan analyse
• make server: run cd public/ && php -S 127.0.0.1:8008
• make remover: run rm -rf var/ && rm -rf vendor/

Docker

• make docker-start: run docker-compose up -d --build && docker-compose exec api composer install
• make docker-restart: run rm -rf var/ && rm -rf vendor/ && docker-compose up -d --build && docker-compose exec api composer install
• make docker-build: run docker-compose up -d --build
• make docker-install: run docker-compose exec api composer install
• make docker-down: run docker-compose down
• make docker-rm: run docker rm $(docker ps -aq) -f
• make docker-rmi: run docker rmi $(docker images -aq) -f

Installation

You can install the project in two ways

From packagist.org

composer create-project reiterus/microapi-core

From GitHub repository

{
 "repositories": [
  {
   "type": "vcs",
   "url": "https://github.com/reiterus/microapi-core.git"
  }
 ]
}

License

This library is released under the MIT license.