Librarian 📚

Librarian API is a .NET-based web API for managing a book library, designed for study purposes. It provides endpoints for adding, retrieving, updating, and deleting books in a book library, and serves as a learning resource for understanding API development using .NET technologies.

Features 💻

Librarian API will include the following features:

• [x] CRUD (Create, Read, Update, Delete) operations for managing books in a library.
• [ ] Token-based authentication and authorization for securing API endpoints.
• [ ] Swagger documentation for easy API exploration and testing.
• [ ] Follows RESTful API design principles.
• [ ] Utilizes best practices for .NET development, including dependency injection, data access with Entity Framework Core, and exception handling.

Installation 🛠

To install and run the Librarian API, follow these steps:

1. Clone the repository to your local machine using the following command:

2. Change to the directory where Librarian API is cloned:

3. Install the required dependencies by running the following command:

4. Build the solution by running the following command

5. Run the API using the following command:

6. The API will be hosted at https://localhost:5001 by default. You can access it using a web browser or a tool like Postman for API testing.

Usage ✏️

The Librarian API provides the following endpoints for managing a book library:

GET /api/books: Retrieves all books in the library.

GET /api/books/{id}: Retrieves a specific book by its ID.

POST /api/books: Adds a new book to the library.

PUT /api/books/{id}: Updates an existing book by its ID.

DELETE /api/books/{id}: Deletes a book from the library by its ID.

Contributing 💬

This repository is intended for study purposes only and is not currently open for external contributions.

Contact

If you have any questions or suggestions about the Librarian API, please feel free to contact me. I appreciate your feedback and would be happy to assist you 💜