Create a WEB API

Here's a simple example of a web API built using Python and the Flask framework. This API provides basic CRUD (Create, Read, Update, Delete) operations for managing a list of items.

### Prerequisites:
- Python installed on your machine
- Flask library installed (`pip install Flask`)

### Step 1: Create a new Python file (e.g., `app.py`) and paste the following code:

```python
from flask import Flask, jsonify, request

app = Flask(__name__)

# Sample data - a list of items
items = [
    {'id': 1, 'name': 'Item 1', 'description': 'This is item 1'},
    {'id': 2, 'name': 'Item 2', 'description': 'This is item 2'}
]

# Read - GET all items
@app.route('/api/items', methods=['GET'])
def get_items():
    return jsonify(items)

# Read - GET an item by ID
@app.route('/api/items/<int:item_id>', methods=['GET'])
def get_item(item_id):
    item = next((item for item in items if item['id'] == item_id), None)
    if item:
        return jsonify(item)
    return jsonify({'message': 'Item not found'}), 404

# Create - POST a new item
@app.route('/api/items', methods=['POST'])
def add_item():
    new_item = {
        'id': items[-1]['id'] + 1 if items else 1,
        'name': request.json['name'],
        'description': request.json.get('description', '')
    }
    items.append(new_item)
    return jsonify(new_item), 201

# Update - PUT an existing item
@app.route('/api/items/<int:item_id>', methods=['PUT'])
def update_item(item_id):
    item = next((item for item in items if item['id'] == item_id), None)
    if item:
        item['name'] = request.json.get('name', item['name'])
        item['description'] = request.json.get('description', item['description'])
        return jsonify(item)
    return jsonify({'message': 'Item not found'}), 404

# Delete - DELETE an item by ID
@app.route('/api/items/<int:item_id>', methods=['DELETE'])
def delete_item(item_id):
    global items
    items = [item for item in items if item['id'] != item_id]
    return jsonify({'message': 'Item deleted'})

if __name__ == '__main__':
    app.run(debug=True)
```

### Step 2: Run the API
To run the API, navigate to the directory containing your `app.py` file in the terminal or command prompt and run:

```bash
python app.py
```

This will start the Flask development server, and the API will be accessible at `http://127.0.0.1:5000/`.

### Step 3: Test the API
You can use tools like [Postman](https://www.postman.com/) or `curl` commands in the terminal to test the API. Below are some example commands:

- **Get all items:**
  ```bash
  curl http://127.0.0.1:5000/api/items
  ```

- **Get an item by ID:**
  ```bash
  curl http://127.0.0.1:5000/api/items/1
  ```

- **Create a new item:**
  ```bash
  curl -X POST -H "Content-Type: application/json" -d '{"name": "NewItem", "description": "This is a new item"}' http://127.0.0.1:5000/api/items
  ```

- **Update an item:**
  ```bash
  curl -X PUT -H "Content-Type: application/json" -d '{"name": "UpdatedItem", "description": "This is an updated item"}' http://127.0.0.1:5000/api/items/1
  ```

- **Delete an item:**
  ```bash
  curl -X DELETE http://127.0.0.1:5000/api/items/1
  ```

This is a basic example, but it demonstrates the fundamental principles of building a RESTful web API with Flask. You can expand on this by adding authentication, connecting to a database, or implementing more complex logic.

Comments

Post a Comment

Popular posts from this blog

Data Types - SQL

  SQL Data Types Data types and ranges for Microsoft Access, MySQL and SQL Server. Microsoft Access Data Types Data type Description Storage Text Use for text or combinations of text and numbers. 255 characters maximum Memo Memo is used for larger amounts of text. Stores up to 65,536 characters. Note:  You cannot sort a memo field. However, they are searchable Byte Allows whole numbers from 0 to 255 1 byte Integer Allows whole numbers between -32,768 and 32,767 2 bytes Long Allows whole numbers between -2,147,483,648 and 2,147,483,647 4 bytes Single Single precision floating-point. Will handle most decimals 4 bytes Double Double precision floating-point. Will handle most decimals 8 bytes Currency Use for currency. Holds up to 15 digits of whole dollars, plus 4 decimal places. Tip:  You can choose which country's currency to use 8 bytes AutoNumber AutoNumber fields automatically give each record its own number, usually starting at 1 4 bytes Data/Time Use for dates and ti...
Read more

Smart Monitor

A smart monitor is essentially a computer monitor with built-in features commonly found in smart TVs, like internet connectivity, apps, and multimedia functionality. Here are some of its uses: 1. Standalone Media Hub: Smart monitors come with built-in streaming apps, like Netflix, YouTube, and Hulu, allowing you to watch shows, movies, and videos directly on the monitor without needing a computer. 2. Productivity Without a PC: Many smart monitors come with office apps, cloud access (like OneDrive or Google Workspace), and even remote desktop capabilities. You can edit documents, check emails, or attend video calls without connecting to a traditional computer. 3. Wireless Connectivity: Smart monitors support wireless connectivity options, like screen mirroring and AirPlay, making it easy to cast content from your phone, tablet, or laptop. This is especially useful for presentations or collaborative work. 4. Built-in Voice Assistants: Some smart monitors integrate voice assistants (like ...
Read more

Windows 10 Hotkeys

Keypress {When these keys are pressed} Action {Results in this} Alt + Enter Display properties for the selected item. Alt + Esc Cycle through items in the order in which they were opened. Alt + F4 Close the active item, or exit the active app. Alt + F8 Show your password on the sign-in screen. Alt + Left arrow Go back. Alt + Page Down Move down one screen. Alt + Page Up Move up one screen. Alt + Right arrow Go forward. Alt + Shift + arrow keys When a group or tile is in focus on the Start menu, move it in the direction specified. Alt + Spacebar Open the shortcut menu for the active window. Alt + Tab Switch between open apps. Alt + underlined letter Perform the command for that letter. Ctrl + A Select all items in a document or window. Ctrl + Alt + Tab Use the arrow keys to switch between all open apps. Ctrl + arrow key (to move to an item) + Spacebar Select multiple individual items in a window or on the desktop. Ctrl + arrow keys Resize the Start menu when it's open. Ctrl + C (or ...
Read more