Git Product home page Git Product logo

api_dev_demo's Introduction

api_dev_demo

Python API Development Demo

This repository contains a demo project created while learning API development with Python. The project includes basic setup, routes, and functionality to demonstrate the fundamentals of building an API.

Table of Contents

Introduction

This demo project was developed as part of a learning exercise to understand API development using Python. The project uses FastAPI to create and manage API endpoints. FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints.

Features

  • Basic API setup using FastAPI
  • CRUD (Create, Read, Update, Delete) operations
  • Error handling
  • Data validation with Pydantic models
  • Interactive API documentation with Swagger UI and ReDoc

Installation

To get started with this project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/bipuldevashish/api_dev_demo
    cd api_dev_demo
  2. Create a virtual environment:

    python3 -m venv venv
    source venv/bin/activate   # On Windows, use `venv\Scripts\activate`
  3. Install dependencies:

    pip install -r requirements.txt

Usage

To run the API server, use the following command:

uvicorn main:app --reload

api_dev_demo's People

Contributors

bipuldevashish 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.