https://github.com/stynw7/ureeka_api_project

As a Ureeka Member, I'm creating API Project based on the instruction given
https://github.com/stynw7/ureeka_api_project

api backend laravel postman

Last synced: 26 days ago
JSON representation

As a Ureeka Member, I'm creating API Project based on the instruction given

• Host: GitHub
• URL: https://github.com/stynw7/ureeka_api_project
• Owner: StyNW7
• Created: 2024-06-15T06:17:14.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-06-15T07:56:21.000Z (8 months ago)
• Last Synced: 2024-11-12T00:19:15.485Z (3 months ago)
• Topics: api, backend, laravel, postman
• Language: PHP
• Homepage:
• Size: 77.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ureeka API Project

## Introduction

As a member of Ureeka, I have a project to make an API and also make a documentation using Postman

## Library Management API Documentation

Welcome to the Library Management API documentation. This API provides endpoints to manage users and books within a library system.

### Endpoints

#### 1. Login

Description: Authenticate a user to obtain an access token.

Endpoint: POST /api/login

Usage: Use this request to log in with your registered credentials. On successful authentication, you'll receive an access token to access protected endpoints.

#### 2. Register

Description: Register a new user.

Endpoint: POST /api/register

Usage: Register a new user with a unique email address. Provide name, email, password, and password confirmation in the request body to create a new user account.

#### 3. Get User

Description: Retrieve user details.

Endpoint: GET /api/user

Usage: Fetch details of the currently authenticated user. Include the access token obtained from the login request in the Authorization header as a Bearer token.

#### 4. View Books

Description: Retrieve all books.

Endpoint: GET /api/books

Usage: Retrieve a list of all books available in the library. Requires authentication; include the access token in the Authorization header.

#### 5. Add Books

Description: Add a new book (Admin only).

Endpoint: POST /api/books

Usage: Add a new book to the library collection. Only accessible to users with admin privileges. Provide book details including title, ISBN, author, and year of publication in the request body.

#### 6. Update Books

Description: Update an existing book (Admin only).

Endpoint: PUT /api/books/{id}

Usage: Update details of an existing book identified by {id}. Only accessible to users with admin privileges. Provide updated book details in the request body.

#### 7. Delete Books

Description: Delete a book (Admin only).

Endpoint: DELETE /api/books/{id}

Usage: Delete a book from the library collection identified by {id}. Only accessible to users with admin privileges. No request body is required; just provide the book ID in the endpoint URL.

### Getting Started

#### Authentication:

Start by logging in with your credentials using the Login request. Copy the access token from the response.

Use the obtained token as a Bearer token in the Authorization header for subsequent requests.

#### Managing Books:

Use View Books to see all available books.

Add new books using Add Books, ensuring to provide all required details.

Update existing books with Update Books, specifying the book ID and updated information.

Delete unwanted books using Delete Books, supplying the book ID to remove from the collection.

#### User Management:

Retrieve user details with Get User to view your own profile information.

### Notes:

Ensure proper authentication for requests requiring admin privileges (Add Books, Update Books, Delete Books).

Validate request bodies to meet API requirements, such as unique email addresses for user registration and complete book details for Add Books and Update Books.

## Postman Documentation Link:

Postman Documentation Link

## Made By

Name: Stanley Nathanael Wijaya





Always strive for excellence ✨✨