https://github.com/chisa-dev/global-tongue
API Documentation for Global Tongue Education Website
https://github.com/chisa-dev/global-tongue
api laravel
Last synced: 3 months ago
JSON representation
API Documentation for Global Tongue Education Website
- Host: GitHub
- URL: https://github.com/chisa-dev/global-tongue
- Owner: chisa-dev
- Created: 2023-07-29T08:33:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-14T14:14:13.000Z (over 1 year ago)
- Last Synced: 2025-02-10T22:36:59.381Z (3 months ago)
- Topics: api, laravel
- Language: PHP
- Homepage: https://api.globaltongueedu.com/
- Size: 10.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Global Tongue Edu. API Documentation
----
### Language & Framework Used:
1. PHP-8
1. Laravel-9
### Older Versions (if Needed):
1. Laravel 8.x - https://github.com/ManiruzzamanAkash/Laravel-Advanced-CRUD-API/releases/tag/vLaravel8.x
### Architecture Used:
1. Laravel 9.x
1. Interface-Repository Pattern
1. Model Based Eloquent Query
1. Swagger API Documentation - https://github.com/DarkaOnLine/L5-Swagger
1. JWT Auth - https://github.com/tymondesigns/jwt-auth
1. PHP Unit Testing - Some basic unit testing added.
### API List:
##### Authentication Module
1. [x] Register User API with Token
1. [x] Login API with Token
1. [x] Authenticated User Profile
1. [x] Refresh Data
1. [x] Logout
##### Product Module
1. [x] Product List
1. [x] Product List [Public]
1. [x] Create Product
1. [x] Edit Product
1. [x] View Product
1. [x] Delete Product
### How to Run:
1. Clone Project -
```bash
git clone https://github.com/ManiruzzamanAkash/Laravel-Basic-CRUD-API.git
```
1. Go to the project drectory by `cd Laravel-Basic-CRUD-API` & Run the
2. Create `.env` file & Copy `.env.example` file to `.env` file
3. Create a database called - `laravel_basic_crud`.
4. Install composer packages - `composer install`.
5. Now migrate and seed database to complete whole project setup by running this-
``` bash
php artisan migrate:refresh --seed
```
It will create `21` Users and `103` Dummy Products.
6. Generate Swagger API
``` bash
php artisan l5-swagger:generate
```
7. Run the server -
``` bash
php artisan serve
```
8. Open Browser -
http://127.0.0.1:8000 & go to API Documentation -
http://127.0.0.1:8000/api/documentation
9. You'll see a Swagger Panel.
### Procedure
1. First Login with the given credential or any other user credential
1. Set bearer token to Swagger Header or Post Header as Authentication
1. Hit Any API, You can also hit any API, before authorization header data set to see the effects.
### Demo
###### API List Views:
###### Login in Swagger with Given Data:
###### Get token After Successful Login:
###### Set token in Swagger Header:
###### Or, Set token in Postman Header as Authorization:
###### Hit Any API Route in Swagger:
###### Image Upload throw Postman:
### Test
1. Test with Postman - https://www.getpostman.com/collections/5642915d135f376b84af [Click to open with post man]
1. Test with Swagger.
1. Swagger Limitation: Image can not be uploaded throw Swagger, it can be uploaded throw Postman.