zim32/symfony-skeleton-rest-only

v6.1.1 2022-06-25 20:28 UTC

Requires

• php: >=8.1
• ext-ctype: *
• ext-iconv: *
• doctrine/doctrine-bundle: ^2.7
• doctrine/doctrine-migrations-bundle: ^3.2
• doctrine/orm: ^2.12
• lexik/jwt-authentication-bundle: ^2.16
• symfony/console: 6.1.*
• symfony/dotenv: 6.1.*
• symfony/flex: ^2
• symfony/framework-bundle: 6.1.*
• symfony/property-access: 6.1.*
• symfony/property-info: 6.1.*
• symfony/proxy-manager-bridge: 6.1.*
• symfony/runtime: 6.1.*
• symfony/security-bundle: 6.1.*
• symfony/serializer: 6.1.*
• symfony/twig-bundle: 6.1.*
• symfony/validator: 6.1.*
• symfony/yaml: 6.1.*
• twig/extra-bundle: ^2.12|^3.0
• twig/twig: ^2.12|^3.0
• zim32/symfony-rest-helper-bundle: ^3.0
• zircote/swagger-php: ^4.4

Requires (Dev)

• symfony/maker-bundle: ^1.43

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php72: *
• symfony/polyfill-php73: *
• symfony/polyfill-php74: *
• symfony/polyfill-php80: *
• symfony/polyfill-php81: *

proprietary

README

Description

This is a template application for creating REST API's based on Symfony framework

• Symfony 5.4
• SwaggerUI

Installation

Create project

composer create-project zim32/symfony-skeleton-rest-only folder_name '5.4.*'
composer update

Generate JWT keys

See official bundle docs: https://github.com/lexik/LexikJWTAuthenticationBundle

Add this to your .env.local file (change for your needs)

APP_ENV=dev
DATABASE_URL=YOUT_DB_DSN
API_SCHEMA_URL=http://your-domain/api/v1/doc/schema
API_ENDPOINT_URL=http://your-domain/api/v1
JWT_SECRET_KEY=%kernel.project_dir%/config/jwt/private.pem
JWT_PUBLIC_KEY=%kernel.project_dir%/config/jwt/public.pem

Usage

There are some test entities and resources in this skeleton project, so you can nagivate to http://yout-domain/api/v1/doc/ and start playing