Pular para o conteúdo principal

Gluo Core

Build Status Opensource ByJG GitHub source GitHub license GitHub release

The Gluo framework core — the glue ("gluo" is Esperanto for glue) that binds the byjg components into a REST architecture.

You normally don't install this package directly. Start a project with the byjg/gluo starter instead:

composer create-project byjg/gluo my-api

The starter generates a project you fully own; byjg/gluo-core stays in vendor/ and framework improvements arrive with a plain composer update.

What's inside

  • Base classesBaseLoginController, BaseRepository, BaseService, BaseUser, BaseUserProperties, BaseConfigBootstrap
  • AttributesRequireAuthenticated, RequireRole, ValidateRequest
  • UtilitiesJwtContext, OpenApiContext, FakeApiRequester
  • Builder — database migration entry points, OpenAPI generation, and the code generator (composer codegen) with its Jinja templates
  • Test harnessBaseApiTestCase for contract-testing your REST endpoints against the OpenAPI definition
  • TraitsOaCreatedAt, OaUpdatedAt, OaDeletedAt

Install

composer require byjg/gluo-core

Documentation

The full documentation (getting started, guides, and reference) lives in the byjg/gluo starter repository.

Running the tests

composer install
vendor/bin/phpunit

Open source ByJG