Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/khachornchit/php-symfony4-restful-api

It is a sample PHP/Symfony project to develop REST API application with CRUD method using Symfony version 4.2 framework and PHP version 7.2.10, under docker container environment.
https://github.com/khachornchit/php-symfony4-restful-api

composer docker docker-compose mysql php php7 restful-api symfony symfony4 web-api

Last synced: 29 days ago
JSON representation

It is a sample PHP/Symfony project to develop REST API application with CRUD method using Symfony version 4.2 framework and PHP version 7.2.10, under docker container environment.

Awesome Lists containing this project

README

        

[![Build Status](https://travis-ci.org/Khachornchit/PHP-Symfony4-RESTful-API.svg?branch=master)](https://travis-ci.org/Khachornchit/PHP-Symfony4-RESTful-API)

# Web API Development using PHP Symfony 4.2
It is a sample PHP/Symfony project to develop REST API application with CRUD method using Symfony version 4.2 framework and PHP version 7.2.10, under docker container environment.

So, make sure you have installed docker and docker-compose ready on your environment. Then, you can follow the setup guide step by step.

## Technology Stack
* Linux
* Apache
* MySQL
* PHP 7.2, Symfony 4.2
* Docker

## Pre-requires
* Install [Docker](https://www.docker.com/)

## Getting started
* Clone the repository
```
git clone https://github.com/Khachornchit/PHP-Symfony4-RESTful-API.git
```
* Build the project
```
cd PHP-Symfony4-RESTful-API
docker-compose build
docker-compose up -d
```
* Install dependencies
```
docker-compose exec php bash
cd symfony
composer install
php bin/console doctrine:database:create
php bin/console doctrine:migrations:migrate
exit
```

## phpMyAdmin
* [phpMyAdmin](http://localhost:5033)

## API Endpoint
* [API Endpoint](http://localhost:5031/api)

## CRUD
```
POST /users
GET /users
GET /users/{id}
PUT /users/{id}
DELETE /users/{id}
```

## Data
* Example of request data
```
{
"username":"user1",
"userpassword": "A1234!@#$"
}
```
* Example of response data
```
{
"id": 1,
"username": "user1",
"description": "Passed verification."
}
```