Giter VIP home page Giter VIP logo

booksdata-restapi's Introduction

FastAPI Book API

This is a simple FastAPI application for managing books using MongoDB.

Prerequisites

Before running the application, make sure you have the following installed:

  • Python 3.7 or higher
  • MongoDB Atlas account (or a local MongoDB instance)

Setup

  1. Clone the repository:
git clone https://github.com/Shanu79/restapi-letsbloom.git
cd restapi-letsbloom-master
  1. Install dependencies:
pip install -r requirements.txt
  1. Configure MongoDB:

    • Create a MongoDB Atlas cluster or use a local MongoDB instance.
  2. Configure the .env file:

    • create a new .env file
    • Update the uri variable in the .env file with your MongoDB connection string.
    • Update the JSON_DATA_PATH with your actual dummy data file is located
  3. Run the application:

uvicorn main:app --reload

The application should now be running at http://localhost:8000.

API Documentation

Visit http://localhost:8000/docs to access the Swagger UI for API documentation.

Endpoints

  • GET /api/books: List all books.
  • POST /api/books: Add new books.
  • PUT /api/books/{id}: Update books
  • /seed-database: Seed the Database with dummy data

booksdata-restapi's People

Contributors

shanu79 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.