Simple restful ordering service with Symfony 5

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Tasks
5. Contact

About The Project

This service includes JWT login and registration. The purpose of the service is to create an order, edit the created order, view all orders and present the order details via API for the customer logged in with JWT.

(back to top)

Getting Started

You can follow the simple guidelines below to get the project working.

Prerequisites

To run this project, PHP 7.4 (or higher) and composer must be installed.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._

1. Clone the repo

   git clone https://github.com/Mhmmdkyr/symfony-order.git

2. Install composer packages

   composer install

3. Edit the .env file yourself.

   DATABASE_URL=mysql://root:root@127.0.0.1:3309/symfony_case
   

(back to top)

Usage

Register [POST]

All field required.

   /api/register

Param	Type	Default	Description
username	string	null	Username
password	string	null	Password
email	string	null	E-mail address

Login [POST]

All field required.

   /api/login_check

Param	Type	Default	Description
username	string	null	Username
password	string	null	Password

All Orders [GET]

   /api/order

Show Order [GET]

   /api/order/show/{order_code}

New Order [POST]

   /api/order/add

Param	Type	Required	Description
orderCode	string	yes	Order Code
productId	integer	yes	Product ID
quantity	integer	yes	Quantity to order
address	string	yes	Order delivery address

Edit Order [POST]

As all parameters update know, only one parameter can also be updated.

   /api/order/edit/{order_code}

Param	Type	Required	Description
orderCode	string	no	Order Code
productId	integer	no	Product ID
quantity	integer	no	Quantity to order
address	string	no	Order delivery address

(back to top)

Tasks

• JWT Login and Register
• Show all orders
• Add an order
• Show an order
• Edit an order
• Add README.md file
• Add Postman Collection
• Unit Tests
• Docker Image

(back to top)

Contact

Muhammed Kayar - @mhmmdkyr - mail@muhammedkayar.com.tr

Project Link: https://github.com/Mhmmdkyr/symfony-order

(back to top)