goodnewsperfect / hngx-task2

HNGx CRUD API Documentation

Welcome to the CRUD API documentation Laravel application. This API allows you to Create, Read, Update, and Delete user records.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• API Endpoints
• Request and Response Formats
• Sample Usage

Getting Started

Prerequisites

Before you start, make sure you have the following prerequisites installed on your system:

• PHP (>= 7.4)
• Composer
• Laravel (>= 8.x)
• Database (e.g., MySQL, PostgreSQL)

Installation

1. Clone this repository:

   git clone https://github.com/GoodnewsPerfect/HNGx-task2
   cd HNGx-task2 

2. Install PHP dependencies using Composer:

   composer install

3. Create a .env file by copying the .env.example file and configure your database settings:

   cp .env.example .env

   Configure the database config variables as follows:

   DB_CONNECTION=mysql
   DB_HOST=127.0.0.1
   DB_PORT=3306
   DB_DATABASE=laravel
   DB_USERNAME=root
   DB_PASSWORD=
   

4. Run the migrations:

   php artisan migrate

5. Start the development server:

   php artisan serve
   

   Laravel API is now up and running on {127.0.0.1:8000} which is the base url!

API Endpoints

Request and Response Formats

The API uses JSON for both requests and responses. The following table describes the JSON format for the requests and responses:

Requests	Response
POST /api	201 Created with the newly created user in the response body
GET /api	200 OK with an array of users in the response body.
GET /api/{id}	200 OK with the user with the specified id in the response body.
PUT /api/{id}	200 OK with the updated user in the response body.
DELETE /api/{id}	204 No Content

Sample Usage

Adding a new user (201 Created)

Fetch a user detail (200 OK)

Modify the details of an existing user (200 OK)

Remove a user (204 No Content)

Fetch users (200 OK)