Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 1.42 KB

README.md

File metadata and controls

51 lines (38 loc) · 1.42 KB

symfony-todo-rest

A simple RESTful API for ToDo items based on Symfony 5.

CI Status GitHub last commit Scrutinizer Code Quality PHPStan

Features

  • Request validation
  • Serialization of entities to json and deserialization from json to entities using symfony/serializer
  • Generated Swagger Documentation based on Code and Annotations (nelmio/api-doc-bundle)
  • Centralized Exception Handler always returns JSON responses when an exception occurs
  • Usage of Doctrine Param Converter

Infrastructure

  • PHP 7.4
  • PostgreSQL 13
  • Symfony 5.2
  • Doctrine ORM
  • Nginx

Dev Tools

  • phpstan
  • php-cs-fixer
  • Xdebug 3
  • Composer 2
  • PHPUnit
  • GitHub Workflow

Setup

Browse to directory dev

make setup

Run

  1. Browse to directory dev
  2. make start to start docker containers
  3. Request endpoints (see Postman Collection (dev/Symfony ToDo.postman_collection.json))

See API Documentation: http://symfony-todo-rest.dev.local:8100/api/doc

ToDo

  • GET all: pagination
  • GET all: sorting
  • GET all: filter
  • Authentication (JWT)