Skip to content

rest api skeleton based on symfony-flex, api-platform, fosuserbundle etc.

License

Notifications You must be signed in to change notification settings

svp1989/symfony-api-skeleton

Repository files navigation

symfony-api-skeleton

JSON REST API simple skeleton based on symfony-flex, JWT, api-platform, fosuserbundle etc.

Installation

1. Clone repository

Create project :

composer create-project svp1989/symfony-api-skeleton:@dev

Or clone repository from GitHub:

git clone https://github.com/svp1989/symfony-api-skeleton.git

2. Dependencies installation

Install all needed dependencies:

composer install

3. Create JWT auth keys

Create JWT auth keys and configure .env:

ssh-keygen -t rsa -b 4096 -f private.pem
openssl rsa -in private.pem -pubout -outform PEM -out public.pem

4. Configuration

Create .env file, which contains all the necessary environment variables that application needs:

cp .env.dist .env

5. Create database

Create database and upload fixtures:

bin/console doctrine:database:create 
bin/console doctrine:schema:create
bin/console doctrine:fixtures:load

6. Start server

Start server and open in the browser http://127.0.0.1:8000/api/doc:

bin/console server:start

Authorisation

Go to route /api/login:
ROLE_USER:
--username:user
--password:user

ROLE_ADMIN
--username:admin
--password:admin

About

rest api skeleton based on symfony-flex, api-platform, fosuserbundle etc.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published