mrprompt/silex-api-skel

Silex REST Application Skeleton

dev-master 2016-10-22 17:00 UTC

This package is auto-updated.

Last update: 2019-12-29 03:21:40 UTC


README

Build Status Codacy Badge Scrutinizer Code Quality Build Status Code Climate Issue Count Test Coverage

API REST Skeleton

Este é um projeto exemplo de uso do Silex Framework para aplicações que exijam performance, fácil manutenção e escalabilidade.

Ele utiliza sub componentes como:

Instalação

É necessário o PHP 7.0.x

Extensões necessárias

  • curl
  • pdo
  • reflection
  • json
  • xdebug (opcional)

Instalação

Baixe o Composer

Baixe o esqueleto do projeto

composer.phar create-project mrprompt/silex-api-skel some-dir --stability dev --no-interaction

Instale as dependências

composer.phar install --prefer-dist -o

Rodando localmente

Você pode utilizar o servidor web embutido no PHP para rodar localmente a API. Ou se preferir, configurar seu servidor web preferido apontando para a pasta public.

php -S localhost:8080 -t public

Rodando em modo desenvolvimento

Rodar a API em modo de desenvolvimento, você deve definir a variável de ambiente APPLICATION_ENV com o valor development. Caso a variável não esteja definida, o valor padrão é production. Em modo de desenvolvimento, a aplicação irá mostrar todas as mensagens de erro e também de irá logar as mensagens de debug.

APPLICATION_ENV="development" php -S localhost:8080 -t public

Testando

./vendor/bin/phpunit

Rotas

  • User

    • Url: /user/1
    • Método: GET
  • User

    • Url: /user/
    • Método: GET

Como contribuir

  • faça um fork e envie um pull request
  • clique em 'star' :)