https://github.com/maxpou/silex-boilerplate

A lightweight Silex application which provide an API with HAL/HATEOAS
https://github.com/maxpou/silex-boilerplate

doctrine hal hateoas php silex

Last synced: 7 months ago
JSON representation

A lightweight Silex application which provide an API with HAL/HATEOAS

• Host: GitHub
• URL: https://github.com/maxpou/silex-boilerplate
• Owner: maxpou
• License: mit
• Created: 2016-10-12T09:33:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-12T11:48:47.000Z (almost 9 years ago)
• Last Synced: 2025-01-16T02:29:38.713Z (9 months ago)
• Topics: doctrine, hal, hateoas, php, silex
• Language: PHP
• Homepage:
• Size: 9.77 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Social network API

[![Build Status](https://travis-ci.org/maxpou/silex-boilerplate.svg?branch=master)](https://travis-ci.org/maxpou/silex-boilerplate)

A lightweight [Silex](http://silex.sensiolabs.org/) application which provide an API with [HAL](http://stateless.co/hal_specification.html)/HATEOAS.

## Installation

1. Adapt `app/config.yml` file according to your database configuration (host, user and password)

2. Install PHP dependencies: `composer install`

3. Run a server: `composer run` (or manually `php -S 0.0.0.0:4000 -t web/`)

**Note:** The demo need a database. The SQL file is available in `app/demo.sql`.

## Using

Open [Postman](https://www.getpostman.com/docs/introduction)/[DHC](https://restlet.com/products/dhc/) at http://localhost:4000/  

Then navigate into the API.

*Demo* API Endpoints:

* http://127.0.0.1:4000/: home

* http://127.0.0.1:4000/users: List of the users

* http://127.0.0.1:4000/users/{id}: Retrieve a specific user

**Note:** A `dev mode` is also available at http://localhost:4000/index_dev.php. It's include the Web Profiler (Symfony web debug toolbar).

## What's inside?

* [doctrine/dbal](http://silex.sensiolabs.org/doc/providers/doctrine.html): The doctrine service provider (for easy database access).

* [symfony/yaml](http://symfony.com/doc/current/components/yaml.html): The Symfony YAML component (useful for parameters).

* [monolog/monolog](http://silex.sensiolabs.org/doc/providers/monolog.html): Because, we can't imagine an app without logs!

* [willdurand/hateoas](https://github.com/willdurand/hateoas): A PHP library to build HATEOAS REST web services.

## Tests

Run test with:

* `composer test`: run the PHPUnit tests

* `composer coverage`: run the PHPUnit tests + generate a code coverage (report folder)