Express Books API

A simple RESTful API for managing a collection of books built with Express.js.

Features

• CRUD operations for books
• Advanced search and filtering
• Sorting capabilities
• Pagination support
• JSON-based responses
• Input validation
• Error handling

Prerequisites

• Node.js (v14 or higher)
• pnpm (or npm/yarn)
• .env file with PORT configuration

Installation

1. Clone the repository:

   git clone <repository-url>
   cd express-books-api

2. Install dependencies:

   pnpm install

3. Create a .env file in the root directory:

   PORT=3000
   

4. Start the server:

   pnpm start

API Endpoints

Get all books

GET /books

Returns a list of all books. Supports the following query parameters:

• search: Search books by title or author
• sort: Field to sort by (id, title, author, pages)
• sortBy: Sort direction (asc or desc)
• filter: Field to filter by (title or author)
• filterBy: Value to filter with
• page: Page number for pagination
• pageSize: Number of items per page

Example queries:

/books?sort=pages&sortBy=desc
/books?search=tolkien
/books?filter=author&filterBy=George
/books?page=1&pageSize=10

Get a specific book

GET /books/:id

Returns a single book by ID.

Create a new book

POST /books

Creates a new book. Required fields in request body:

• title: string
• author: string
• pages: number

Update a book

PUT /books/:id

Updates a book. Optional fields in request body:

• title: string
• author: string
• pages: number

Delete a book

DELETE /books/:id

Deletes a book by ID.

Response Formats

Success Responses

• 200: Successful GET/PUT request
• 201: Successful POST request
• 204: Successful DELETE request

Error Responses

• 400: Invalid request body
• 404: Book not found

Example Book Object

{
  "id": 1,
  "title": "1984",
  "author": "George Orwell",
  "pages": 328
}

Example Queries

Search for books by Tolkien

GET /books?search=tolkien

Get the longest books first

GET /books?sort=pages&sortBy=desc

Get books by George Orwell with pagination

GET /books?filter=author&filterBy=George&page=1&pageSize=10

Development

To run the server in development mode:

pnpm dev

License

MIT