Git Product home page Git Product logo

api's Introduction

API Design

Simple RESTful API Design with Flask

This repo provides a basic example of designing a RESTful API using Flask.

Directory Structure

. ├── app │ ├── models │ │ └── item.py │ │ └── user.py │ ├── routes │ │ ├── init.py │ │ ├── item_routes.py │ │ └── auth_routes.py │ ├── util │ │ ├── errors.py │ │ └── decorators.py │ ├── config.py │ └── extensions.py ├── migrations ├── manage.py ├── app.py ├── requirements.txt └── README.md

API routes

GET /items: Fetch all items. POST /items: Create a new item. GET /items/int:id: Fetch a specific item by ID. PUT /items/int:id: Update a specific item by ID. DELETE /items/int:id: Delete a specific item by ID.

Installation

  1. Clone the repository:
git clone https://github.com/ak-b/flask-api-design.git

2. Create a virtual environment and activate it:
cd flask-api-design
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate

3. Install the dependencies:
pip install -r requirements.txt

4.Run the app:
python app.py

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.