khomcvla / meta-it-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

.Net WebAPI for Managing a Simple Book Catalog

Description

.Net WebAPI that empowers clients to efficiently manage a straightforward book catalog.

Features

  1. Retrieve All Books

    • The API now effortlessly returns a comprehensive list of books from the catalog.
  2. Get Book by ID

    • Clients can seamlessly obtain information about a specific book using its unique identifier.
  3. Add a New Book

    • Adding new books to the catalog is now a streamlined process.
  4. Update Existing Book Information

    • Clients have the capability to update information for books already present in the catalog.
  5. Delete a Book from the Catalog

    • The API enables the removal of a book from the catalog with ease.

Testing

The API has undergone rigorous testing through unit tests to ensure reliability and proper functionality.

Documentation

To facilitate the use of this API, comprehensive documentation has been generated using Swagger/OpenAPI tools.

Database

For storing information about books, a PostgreSQL database has been employed. The database can be run locally.

Testing URL

For testing purposes, the API URL has been set to: https://localhost:8080

BONUS: Docker Integration

As a bonus, Docker has been implemented to enhance convenience and portability.


How to Run

To launch the application, simply use the following command:

docker-compose up

image

Some data is already prepared in the database.

image

About


Languages

Language:C# 98.9%Language:Dockerfile 1.1%