Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity
Files
ea70d85f9d528b1bb350ea04e5995e166fd222b5
bookhoard/bruno/README.md
T
john-okeefe ea70d85f9d docs: Update remaining application name references from 'ebook reader' to 'Bookmann' 
- Updated COMPLETE_DOCUMENTATION.md feature descriptions
- Updated user journey reference from 'ebook library' to 'ebook collection'
- Updated all frontend page titles and headers
- Updated Bruno API collection and workspace names
- All references now consistently use 'Bookmann' as the application name
2026-01-21 20:03:30 -05:00

1.9 KiB
Raw Blame History

Bruno API Tests for Bookmann

This directory contains Bruno collection for testing the Bookmann API with comprehensive REST documentation.

Setup

  1. Install Bruno: https://www.usebruno.com/
  2. Open Bruno and import this collection folder
  3. Select the "localhost" environment
  4. Start the application with docker-compose up --build
  5. Register/Login first, then use Bearer token for protected endpoints

Available Tests

Auth (Public Endpoints)

  • Register User: POST /api/auth/register - Create new account
  • Login User: POST /api/auth/login - Authenticate (email or username)
  • Get Profile: GET /api/auth/profile - Get user info (requires token)

Ebooks (Protected - JWT Required)

  • List Ebooks: GET /api/ebooks - Paginated ebook list
  • Get Ebook: GET /api/ebooks/:id - Single ebook details
  • Create Ebook: POST /api/ebooks - Add new ebook
  • Update Ebook: PUT /api/ebooks/:id - Modify ebook metadata
  • Delete Ebook: DELETE /api/ebooks/:id - Remove ebook

Reading Progress (Protected - JWT Required)

  • Get Reading Progress: GET /api/ebooks/:id/progress - User's progress
  • Update Reading Progress: PUT /api/ebooks/:id/progress - Update progress

Documentation Features

Each request includes:

  • Detailed descriptions of functionality
  • Parameter specifications (required/optional, types)
  • Request/Response examples
  • Error response codes and meanings
  • Authentication requirements

Notes

  • Authentication Flow: Register → Login → Use Bearer token for all other requests
  • JWT Tokens: Valid for 24 hours, include in Authorization: Bearer <token> header
  • User Isolation: Progress and data are user-specific
  • Variables: Update ebook_id for testing specific ebooks
  • Security: Passwords hashed with bcrypt, unique email/username constraints
  • JSON: All requests/responses use JSON format
Reference in New Issue View Git Blame Copy Permalink