https://github.com/tidjee-dev/bcd-cogip-api
https://github.com/tidjee-dev/bcd-cogip-api
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tidjee-dev/bcd-cogip-api
- Owner: tidjee-dev
- Created: 2025-01-30T20:37:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-07T16:24:21.000Z (over 1 year ago)
- Last Synced: 2025-02-07T16:27:42.832Z (over 1 year ago)
- Language: PHP
- Homepage: https://bcd-cogip.tidjee-dev.eu/api
- Size: 65.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bcd-cogip-api
> [!WARNING]
> All data in this API are fake and not real. This project is only for learning purpose.
## Overview
Our mission was to produce an API for the Cogip project. This API will returns data about the Cogip project.
It will returns informations about :
- Cogip users
- Cogip type
- Cogip invoice
- Cogip company
- Cogip contact
## Stack used
[](https://www.docker.com/) [](https://symfony.com/) [](https://www.mysql.com/) [](https://github.com/lexik/LexikJWTAuthenticationBundle)
## API routes users
| Method | Route | Description |
|--------|-----------------|--------------------------|
| POST | /api/users | Create Cogip users |
| GET | /api/users | Returns Cogip users |
| GET | /api/users/{id} | Returns Cogip user by id |
| PUT | /api/users/{id} | Update Cogip users |
| DELETE | /api/users/{id} | Delete Cogip users |
## API Types routes
| Method | Route | Description |
|--------|-----------------|--------------------------|
| POST | /api/types | Create Cogip types |
| GET | /api/types | Returns Cogip types |
| GET | /api/types/{id} | Returns Cogip type by id |
| PUT | /api/types/{id} | Update Cogip types |
| DELETE | /api/types/{id} | Delete Cogip types |
## API Invoice routes
| Method | Route | Description |
|--------|--------------------|-----------------------------|
| POST | /api/invoices | Create Cogip invoices |
| GET | /api/invoices | Returns Cogip invoices |
| GET | /api/invoices/{id} | Returns Cogip invoice by id |
| PUT | /api/invoices/{id} | Update Cogip invoices |
| DELETE | /api/invoices/{id} | Delete Cogip invoices |
## API contact routes
| Method | Route | Description |
|--------|--------------------|-----------------------------|
| POST | /api/contacts | Create Cogip contacts |
| GET | /api/contacts | Returns Cogip contacts |
| GET | /api/contacts/{id} | Returns Cogip contact by id |
| PUT | /api/contacts/{id} | Update Cogip contacts |
| DELETE | /api/contacts/{id} | Delete Cogip contacts |
## API company routes
| Method | Route | Description |
|--------|---------------------|-----------------------------|
| POST | /api/companies | Create Cogip companies |
| GET | /api/companies | Returns Cogip companies |
| GET | /api/companies/{id} | Returns Cogip company by id |
| PUT | /api/companies/{id} | Update Cogip companies |
| DELETE | /api/companies/{id} | Delete Cogip companies |
## Credits
This is part of the fullstack ***Cogip project***:
- This [API](https://github.com/tidjee-dev/bcd-cogip-api) by [Pinet Donatien](https://github.com/tidjee-dev) and [de Sadeleer Jason](https://github.com/sakakara)
- The [frontend in React](#) by [Diana Aliabieva](https://github.com/DianaAliabieva) and [Josias mbogle](https://github.com/junior344).