RESTful programavimo supratimas: išsamus vadovas

RESTful API sukūrimas naudojant Node.js ir Express

„JavaScript“ ir „Node.js“ naudojimas su „Express“ sistema

// 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}`));

Sukurkite RESTful API naudodami Python ir Flask

Naudojant Python ir Flask sistemą

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)

Dažni klausimai apie RESTful programavimą

1. Kas yra REST?
2. REST reiškia reprezentacinį valstybės perkėlimą, architektūrinį stilių, skirtą tinklinėms programoms kurti.
3. Kokie yra pagrindiniai REST principai?
4. Pagrindiniai principai apima pilietybės nebuvimą, vienodą sąsają, ištekliais pagrįstus URL ir HATEOAS.
5. Kas yra pilietybės neturėjimas REST?
6. Be pilietybės reiškia, kad kiekvienoje kliento užklausoje serveriui turi būti visa informacija, reikalinga užklausai suprasti ir apdoroti.
7. Kokie HTTP metodai dažniausiai naudojami RESTful API?
8. Įprasti HTTP metodai yra GET, POST, PUT, ir DELETE.
9. Kas yra HATEOAS?
10. HATEOAS reiškia Hypermedia As The Engine Of Application State, kur serveris pateikia nuorodas į kitus išteklius ir veiksmus.
11. Kuo RESTful URL skiriasi nuo kitų?
12. RESTful URL yra pagrįsti daiktavardžiais, žyminčiais išteklius, todėl jie yra intuityvūs ir lengviau suprantami.
13. Kodėl REST yra svarbi vienoda sąsaja?
14. Vienoda sąsaja supaprastina ir atsieja architektūrą, leidžiančią kiekvienai daliai vystytis atskirai.
15. Kas yra išteklių vaizdavimas REST?
16. Išteklių vaizdavimas apima duomenų grąžinimą tokiais formatais kaip JSON arba XML, nurodant išteklių būseną.
17. Kokie yra RESTful API naudojimo pranašumai?
18. Privalumai apima mastelio keitimą, paprastumą, modifikavimą ir geresnį našumą.

Diskusijos pabaiga

RESTful programavimas yra esminė metodika kuriant efektyvias ir keičiamo dydžio žiniatinklio paslaugas. Naudodami tokius principus kaip be pilietybės ir vienodos sąsajos, kūrėjai gali kurti API, kurias lengva prižiūrėti ir išplėsti. „Node.js“ su „Express“ ir „Python“ su „Flask“ pavyzdžiai parodo praktinį įgyvendinimą, suteikiantį tvirtą pagrindą visiems, norintiems sukurti savo RESTful API. Šių pagrindinių sąvokų ir metodų supratimas yra labai svarbus šiuolaikiniam interneto kūrimui.