{"info":{"_postman_id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","name":"Book Management System","description":"

Welcome to the Book Management API! Follow these simple steps to get the project up and running. 🚀

Prerequisites

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

Node.js (v14 or higher) - Download Node.js
\n
Git (optional, for cloning the repository) - Download Git
\n

Step 1: Clone the Repository

First, clone the project repository to your local machine. If you haven’t already, open a terminal and run:

git clone https://github.com/Daltonic/sia_test\ncd sia_test\n\n

Or simply download the project files as a ZIP and extract them.

Step 2: Install Dependencies

Next, navigate to the project folder and install the required dependencies using npm:

npm install\n\n

This will install:

express (Web framework)
\n
sqlite3 (Database driver)
\n
body-parser (Middleware for parsing JSON requests)
\n

Step 3: Start the Server

Once the dependencies are installed, start the server with the following command:

npm start\n\n

If everything is set up correctly, you’ll see:

Server running on http://localhost:9000\n\n

Step 4: Manage the Database

The project uses SQLite for data storage. A file named booksDB.sqlite will be created automatically in the project directory. You can view and edit the database using tools like:

DB Browser for SQLite
\n
Command-line SQLite tool
\n

Troubleshooting

Port Conflict: If port 9000 is already in use, modify the PORT variable in app.js.
\n
Dependency Issues: Run npm install again to ensure all dependencies are installed.
\n

Enjoy managing your books with this API! If you run into any issues, feel free to ask for help. 🎉

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3187120","collectionId":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","publishedId":"2sAYHzHP92","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"28A952"},"publishDate":"2024-12-31T11:45:51.000Z"},"item":[{"name":"Endpoints API","item":[{"name":"Create Book","id":"3f6c1e4a-5c73-4e5f-bf6a-58c5d3892687","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"The Great Gatsby\",\n \"author\": \"F. Scott Fitzgerald\",\n \"pages\": 180,\n \"published\": \"1925\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:9000/books","description":"

URL: POST /books
Description: Add a brand-new book to your collection. 📚

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","name":"Book Management System","type":"collection"}},"urlObject":{"protocol":"http","port":"9000","path":["books"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"a67ce8fd-ea6f-4094-81eb-d24296a4b5df","name":"New Book Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"The Great Gatsby\",\n \"author\": \"F. Scott Fitzgerald\",\n \"pages\": 180,\n \"published\": \"1925\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:9000/books"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"97"},{"key":"ETag","value":"W/\"61-Haoi101NtzH82ZECbRFtGQyQ2Qo\""},{"key":"Date","value":"Mon, 16 Dec 2024 20:34:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"title\": \"The Great Gatsby\",\n \"author\": \"F. Scott Fitzgerald\",\n \"pages\": 180,\n \"published\": \"1925\"\n}"}],"_postman_id":"3f6c1e4a-5c73-4e5f-bf6a-58c5d3892687"},{"name":"Update Book","id":"91605863-1449-4bea-84c9-b01896c106dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"1984 Again\",\n \"author\": \"George Orwell\",\n \"pages\": 328,\n \"published\": \"1949\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:9000/books/1","description":"

URL: PUT /books/:id
Description: Make edits to a book’s details—give it a facelift! 🛠️

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","name":"Book Management System","type":"collection"}},"urlObject":{"protocol":"http","port":"9000","path":["books","1"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"8c2cf17f-23fb-4add-9b99-890d13c897d5","name":"Updated Book Example","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"1984 Again\",\n \"author\": \"George Orwell\",\n \"pages\": 328,\n \"published\": \"1949\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:9000/books/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"87"},{"key":"ETag","value":"W/\"57-IjJGMYkks+lbUBAV+Dh/norLmo4\""},{"key":"Date","value":"Mon, 16 Dec 2024 20:32:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"1\",\n \"title\": \"1984 Again\",\n \"author\": \"George Orwell\",\n \"pages\": 328,\n \"published\": \"1949\"\n}"}],"_postman_id":"91605863-1449-4bea-84c9-b01896c106dd"},{"name":"List Books","id":"a1b94d35-c7b1-4611-80c9-c00cca7ab9f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:9000/books","description":"

URL: GET /books
Description: Fetch a list of all books in your library. Perfect for bookworms! 🧐
How to Use: Send a GET request to http://localhost:9000/books.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","name":"Book Management System","type":"collection"}},"urlObject":{"protocol":"http","port":"9000","path":["books"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"804a272d-f2e0-4f9f-8a4e-25d826919105","name":"Book Listing Example","originalRequest":{"method":"GET","header":[],"url":"http://localhost:9000/books"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"372"},{"key":"ETag","value":"W/\"174-ToZI6bv0kEqe7NBtHAVxbk8aedk\""},{"key":"Date","value":"Mon, 16 Dec 2024 20:34:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"title\": \"1984 Again\",\n \"author\": \"George Orwell\",\n \"pages\": 328,\n \"published\": \"1949\"\n },\n {\n \"id\": 2,\n \"title\": \"To Kill a Mockingbird\",\n \"author\": \"Harper Lee\",\n \"pages\": 281,\n \"published\": \"1960\"\n },\n {\n \"id\": 3,\n \"title\": \"Pride and Prejudice\",\n \"author\": \"Jane Austen\",\n \"pages\": 416,\n \"published\": \"1813\"\n },\n {\n \"id\": 4,\n \"title\": \"The Great Gatsby\",\n \"author\": \"F. Scott Fitzgerald\",\n \"pages\": 180,\n \"published\": \"1925\"\n }\n]"}],"_postman_id":"a1b94d35-c7b1-4611-80c9-c00cca7ab9f9"},{"name":"Show Book","id":"a5d75258-d3e8-4682-bd14-52086d7dc2d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:9000/books/1","description":"

URL: GET /books/:id
Description: Find details about a specific book using its ID. 🔍
How to Use: Replace :id with the book’s ID in the URL (e.g., /books/1) and send a GET request to http://localhost:9000/books/1.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","name":"Book Management System","type":"collection"}},"urlObject":{"protocol":"http","port":"9000","path":["books","1"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ef9acddc-4156-4e02-9ece-bd23783b9dfa","name":"Book Details Example","originalRequest":{"method":"GET","header":[],"url":"http://localhost:9000/books/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"85"},{"key":"ETag","value":"W/\"55-m2+qGGNwiA4YIH00u53c4cf29dA\""},{"key":"Date","value":"Mon, 16 Dec 2024 20:33:11 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"title\": \"1984 Again\",\n \"author\": \"George Orwell\",\n \"pages\": 328,\n \"published\": \"1949\"\n}"}],"_postman_id":"a5d75258-d3e8-4682-bd14-52086d7dc2d7"},{"name":"Remove Book","id":"43ae0dff-9670-4ee9-ae8c-d393c3b27ad8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:9000/books/4","description":"

URL: DELETE /books/:id
Description: Remove a book from your collection. (Farewell, book! 👋)
How to Use: Replace :id with the book’s ID (e.g., /books/1) and send a DELETE request to http://localhost:9000/books/1.

Available Endpoints

Welcome Endpoint
\n
- GET /
  \n
- Response: Welcome to the Book Management API!
  \n
\n
Create a Book
\n
- POST /books
  \n
- { \"title\": \"Book Title\", \"author\": \"Author Name\", \"pages\": 123, \"published\": \"2024-01-01\"}
  \n
\n
Get All Books
\n
- GET /books
\n
Get a Book by ID
\n
- GET /books/:id
\n
Update a Book
\n
- PUT /books/:id
  \n
- Payload (same as Create a Book)
  \n
\n
Delete a Book
\n
- DELETE /books/:id
\n

\n","_postman_id":"c222da47-0be4-438b-aaee-2ebd69277043","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","id":"2608eeac-ff2c-45b9-bc62-ac07ced2e99d","name":"Book Management System","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"id":"1bcd335c-8130-4a0e-854f-13c02ee16a6b","key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}