https://github.com/oricis/api_quasard

This is a Symfony 7 API test
https://github.com/oricis/api_quasard

api doctrine-dbal php83 symfony7

Last synced: about 1 month ago
JSON representation

This is a Symfony 7 API test

• Host: GitHub
• URL: https://github.com/oricis/api_quasard
• Owner: oricis
• Created: 2024-01-30T22:50:39.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-02-14T14:27:40.000Z (9 months ago)
• Last Synced: 2024-09-28T20:21:05.418Z (about 2 months ago)
• Topics: api, doctrine-dbal, php83, symfony7
• Language: PHP
• Homepage:
• Size: 143 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Simple Symfony API

This is a basis API App using Symfony.

Three entities and their endpoints are used: *users*, *notes* and *categories*.

### How to run the app on development

It's necessary to [install the Symfony CLI](https://symfony.com/download#step-1-install-symfony-cli)

before to **run the local server**.

Run command:

    cd my-project/

    symfony server:start -d

*Add `-d` to run the server in background and continue using the console.*

To stop the server:

    symfony server:stop

Watch last server log (only when the server is running):

    symfony server:log

To **access to the application**:

    http://localhost:8000

***NOTE:** restart the server after every composer.json modification.*

More details on: https://symfony.com/doc/current/setup/symfony_server.html

***

### ER schema

    |-------| 1   N |-------| N   N |------------|

    | users |-------| notes |-------| categories |

    |-------|       |-------|       |------------|

 - The user can have notes.

 - Each note belongs to an user.

 - Each note has one or more categories and each category can have many notes.

![BD diagram](./docs/images/bd.png)

### Create DB tables

Use the files from "database/sql" to create the BD tables in this order:

 - create-tables.sql

 - test-inserts.sql

 - constraint-tables.sql

***NOTE:** the inserts are optional, use to check on first place some GET endpoints.*

***NOTE:** the provided SQL was tested on MySQL 8.0.36 on Ubuntu.*

***

### API routes

The available API routes are:

    DELETE | [domain]/api/v1/users/[id]

    GET    | [domain]/api/v1/users

    GET    | [domain]/api/v1/users/[id]/notes

    GET    | [domain]/api/v1/users/[id]/old-notes

    GET    | [domain]/api/v1/users/[id]

    POST   | [domain]/api/v1/users

    PUT    | [domain]/api/v1/users

    DELETE | [domain]/api/v1/notes/[id]/user/[user_id]

    GET    | [domain]/api/v1/notes/[id]

    POST   | [domain]/api/v1/notes

    PUT    | [domain]/api/v1/notes/remove-category

    PUT    | [domain]/api/v1/notes/set-category

    PUT    | [domain]/api/v1/notes

    DELETE | [domain]/api/v1/categories/[id]

    GET    | [domain]/api/v1/categories

    GET    | [domain]/api/v1/categories/[id]

    POST   | [domain]/api/v1/categories

    PUT    | [domain]/api/v1/categories

***NOTE:** routes on the controllers as*

*[attributes](https://symfony.com/doc/current/best_practices.html#best-practice-controller-attributes).*

***

### App Directories

    src/

      |-- Controller/

      |     |-- api/

      |

      |-- Exceptions/

      |

      |-- Repository/

      |     |-- Data/

      |     |-- Traits/

      |

      |-- Service/

      |     |-- Common/

      |     |

      |     |-- Repository/

      |           |-- Category/

      |           |-- CategoryNote/

      |           |-- Common/

      |           |-- Note/

      |           |-- User/

      |

      |-- Util/

            |-- Helpers/

            |     |-- Common/

            |

            |-- Interfaces/

***

@author:  Moisés Alcocer, 2024

@license: Apache 2.0

@repo:    https://github.com/oricis/api_quasard