Memahami Pengaturcaraan RESTful: Panduan Mendalam

Mencipta API RESTful dengan Node.js dan Express

Menggunakan JavaScript dan Node.js dengan rangka kerja Express

// Import required modules
const express = require('express');
const app = express();
const bodyParser = require('body-parser');

// Middleware setup
app.use(bodyParser.json());

// Sample data
let items = [
    { id: 1, name: 'Item 1' },
    { id: 2, name: 'Item 2' }
];

// GET request to fetch all items
app.get('/items', (req, res) => {
    res.json(items);
});

// GET request to fetch a single item by ID
app.get('/items/:id', (req, res) => {
    const item = items.find(i => i.id === parseInt(req.params.id));
    if (!item) return res.status(404).send('Item not found');
    res.json(item);
});

// POST request to add a new item
app.post('/items', (req, res) => {
    const newItem = {
        id: items.length + 1,
        name: req.body.name
    };
    items.push(newItem);
    res.status(201).json(newItem);
});

// PUT request to update an item
app.put('/items/:id', (req, res) => {
    const item = items.find(i => i.id === parseInt(req.params.id));
    if (!item) return res.status(404).send('Item not found');
    item.name = req.body.name;
    res.json(item);
});

// DELETE request to remove an item
app.delete('/items/:id', (req, res) => {
    const itemIndex = items.findIndex(i => i.id === parseInt(req.params.id));
    if (itemIndex === -1) return res.status(404).send('Item not found');
    const deletedItem = items.splice(itemIndex, 1);
    res.json(deletedItem);
});

// Start the server
const port = process.env.PORT || 3000;
app.listen(port, () => console.log(`Server running on port ${port}`));

Membina API RESTful dengan Python dan Flask

Menggunakan Python dan rangka kerja Flask

from flask import Flask, request, jsonify

app = Flask(__name__)

# Sample data
items = [
    {'id': 1, 'name': 'Item 1'},
    {'id': 2, 'name': 'Item 2'}
]

# GET request to fetch all items
@app.route('/items', methods=['GET'])
def get_items():
    return jsonify(items)

# GET request to fetch a single item by ID
@app.route('/items/<int:item_id>', methods=['GET'])
def get_item(item_id):
    item = next((i for i in items if i['id'] == item_id), None)
    if item is None:
        return jsonify({'message': 'Item not found'}), 404
    return jsonify(item)

# POST request to add a new item
@app.route('/items', methods=['POST'])
def add_item():
    new_item = {
        'id': len(items) + 1,
        'name': request.json['name']
    }
    items.append(new_item)
    return jsonify(new_item), 201

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

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

# Start the server
if __name__ == '__main__':
    app.run(debug=True)

Soalan Lazim Mengenai Pengaturcaraan RESTful

1. Apa itu REST?
2. REST adalah singkatan dari Representational State Transfer, gaya seni bina untuk mereka bentuk aplikasi rangkaian.
3. Apakah prinsip utama REST?
4. Prinsip utama termasuk ketiadaan kewarganegaraan, antara muka seragam, URL berasaskan sumber dan HATEOAS.
5. Apakah ketiadaan kewarganegaraan dalam REST?
6. Statelessness bermakna setiap permintaan daripada klien ke pelayan mesti mengandungi semua maklumat yang diperlukan untuk memahami dan memproses permintaan tersebut.
7. Apakah kaedah HTTP yang biasa digunakan dalam API RESTful?
8. Kaedah HTTP biasa ialah GET, POST, PUT, dan DELETE.
9. Apa itu HATEOAS?
10. HATEOAS bermaksud Hypermedia As The Engine Of Application State, di mana pelayan menyediakan pautan kepada sumber dan tindakan lain.
11. Bagaimanakah URL RESTful berbeza daripada yang lain?
12. URL RESTful adalah berdasarkan kata nama yang mewakili sumber, menjadikannya intuitif dan lebih mudah difahami.
13. Mengapa antara muka seragam penting dalam REST?
14. Antara muka yang seragam memudahkan dan memisahkan seni bina, membolehkan setiap bahagian berkembang secara bebas.
15. Apakah perwakilan sumber dalam REST?
16. Perwakilan sumber melibatkan pemulangan data dalam format seperti JSON atau XML, yang mewakili keadaan sumber.
17. Apakah faedah menggunakan API RESTful?
18. Faedah termasuk kebolehskalaan, kesederhanaan, kebolehubahsuaian dan prestasi yang dipertingkatkan.

Menggulung Perbincangan

Pengaturcaraan RESTful ialah metodologi penting untuk mencipta perkhidmatan web yang cekap dan berskala. Dengan memanfaatkan prinsip seperti ketiadaan kewarganegaraan dan antara muka seragam, pembangun boleh membina API yang mudah diselenggara dan dikembangkan. Contoh menggunakan Node.js dengan Express dan Python dengan Flask menunjukkan pelaksanaan praktikal, menyediakan asas yang kukuh untuk sesiapa sahaja yang ingin membangunkan API RESTful mereka sendiri. Memahami konsep dan teknik teras ini adalah penting untuk pembangunan web moden.