alsofronie / lumen-api
Lumen API Scaffolding Project (Based on Laravel Lumen Framework
Installs: 22
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Type:project
Requires
- php: >=5.6.4
- firebase/php-jwt: ^5.0
- laravel/lumen-framework: 5.4.*
- vlucas/phpdotenv: ~2.2
Requires (Dev)
- fzaninotto/faker: ~1.4
- mockery/mockery: ~0.9
- phpunit/phpunit: ~5.0
This package is not auto-updated.
Last update: 2024-11-10 03:20:47 UTC
README
A scaffolding for Lumen Based API, featuring:
- uri based version (with prefix
/api/v1
) - JSON Web Tokens authentication out of the box
- Models with binary Uuid Primary key (version 4)
- 100% Code Coverage for
/app
directory (wish)
Features
Centralized API Exception
Although many will argue a centralized API Error codes approach, I found it
easier to manage in small / medium projects. So, everything the API
throws as an exception is dealt by the ApiException
class, which has
all the internal API codes (maybe an HTML documentation for each code will
be nice) as static implementation.
The validation errors will be returned in the details
component of the
error, with the name of the validation rule. (to be completed).