ahmetbulbul0/Cars-Api

Cars Api Project.

Cars-Api

Cars Api Project

Technologies

• Php
• Laravel

Project Setup Process

Install composer (for php packages)

composer install

Create .env file

1. duplicate the ".env.example" in main folder
2. rename the file you copied to ".env"
3. configure the ".env" file you renamed

Create app key

php artisan key:generate

Run migrations (for create database tables)

php artisan migrate

Run Seeders (for datas)

php artisan db:seed

Run project

php artisan serve

Api Documentation (/api)

Car Types (/car-types)

• Listing
  • Method = GET
  • Route = /
  • Params =
  • • paginate = nullable & boolean
  • • limit = nullable & integer
  • • page = nullable & integer & default:1
• Show
  • Method = GET
  • Route = /{carTypeId}
• Create
  • Method = POST
  • Route = /
  • Data =
  • • name = required & string & unique:car_types,name
• Update
  • Method = PATCH
  • Route = /{carTypeId}
  • Data =
  • • name = required & string & unique:car_types,name
• Delete
  • Method = DELETE
  • Route = /{carTypeId}

Car Brands (/car-brands)

• Listing
  • Method = GET
  • Route = /
  • Params =
  • • paginate = nullable & boolean
  • • limit = nullable & integer
  • • page = nullable & integer & default:1
• Show
  • Method = GET
  • Route = /{carBrandId}
• Create
  • Method = POST
  • Route = /
  • Data =
  • • name = required & string & unique:car_brands,name
• Update
  • Method = PATCH
  • Route = /{carBrandId}
  • Data =
  • • name = required & string & unique:car_brands,name
• Delete
  • Method = DELETE
  • Route = /{carBrandId}

Cars (/cars)

• Listing
  • Method = GET
  • Route = /
  • Params =
  • • paginate = nullable & boolean
  • • limit = nullable & integer
  • • page = nullable & integer & default:1
• Show
  • Method = GET
  • Route = /{carId}
• Create
  • Method = POST
  • Route = /
  • Data =
  • • name = required & string & unique:cars,name
  • • type = required & integer & exists:car_types,id
  • • brand = required & integer & exists:car_brands,id
• Update
  • Method = PATCH
  • Route = /{carId}
  • Data =
  • • name = required & string & unique:cars,name
  • • type = required & integer & exists:car_types,id
  • • brand = required & integer & exists:car_brands,id
• Delete
  • Method = DELETE
  • Route = /{carId}