Python Academy · Lezione

Creare un endpoint REST

Restituire risposte JSON

Creare un endpoint REST è una lezione Python Academy gratuita su CoddyKit. Questa è la lezione 4 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Python Academy, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Python Academy include 4 lezioni in totale.

Che cos'è una REST API?

Una REST API espone risorse tramite HTTP utilizzando verbi standard. Invece di pagine HTML, restituisce dati, generalmente in formato JSON, che possono essere utilizzati da altri programmi.

from flask import Flask, jsonify
app = Flask(__name__)
# REST endpoints return data, not pages
print('REST APIs speak JSON over HTTP')

Restituzione di JSON

jsonify() trasforma un dict o un elenco Python in una risposta JSON con il tipo di contenuto corretto.

from flask import Flask, jsonify
app = Flask(__name__)

@app.route('/api/status')
def status():
    return jsonify({'status': 'ok'})
print('jsonify builds a JSON response')

Conversione automatica dei dict

Le versioni moderne di Flask convertono automaticamente in JSON anche un dict restituito, quindi spesso può omettere jsonify().

from flask import Flask
app = Flask(__name__)

@app.route('/api/ping')
def ping():
    return {'message': 'pong'}
print('Returning a dict yields JSON')

Restituzione di un elenco

Per restituire una raccolta, passi un elenco a jsonify(). In genere ogni elemento è un dict che rappresenta una risorsa.

from flask import Flask, jsonify
app = Flask(__name__)
books = [{'id': 1, 'title': 'A'}, {'id': 2, 'title': 'B'}]

@app.route('/api/books')
def list_books():
    return jsonify(books)
print('Return a list of resources')

GET di una singola risorsa

Utilizzi una parte dinamica dell'URL per recuperare un singolo elemento tramite il relativo id. Restituisca 404 se l'elemento non esiste.

from flask import Flask, jsonify
app = Flask(__name__)
books = {1: {'id': 1, 'title': 'A'}}

@app.route('/api/books/<int:bid>')
def get_book(bid):
    book = books.get(bid)
    if book is None:
        return jsonify({'error': 'not found'}), 404
    return jsonify(book)
print('GET /api/books/1')

Creazione con POST

Una richiesta POST crea una risorsa. Legga il corpo JSON, costruisca il nuovo elemento e lo restituisca con lo stato 201 Created.

from flask import Flask, request, jsonify
app = Flask(__name__)
books = []

@app.route('/api/books', methods=['POST'])
def create_book():
    data = request.get_json()
    book = {'id': len(books) + 1, 'title': data['title']}
    books.append(book)
    return jsonify(book), 201
print('POST creates and returns 201')

Aggiornamento con PUT

PUT sostituisce o aggiorna una risorsa esistente identificata dal relativo id.

from flask import Flask, request, jsonify
app = Flask(__name__)
books = {1: {'id': 1, 'title': 'A'}}

@app.route('/api/books/<int:bid>', methods=['PUT'])
def update_book(bid):
    if bid not in books:
        return jsonify({'error': 'not found'}), 404
    books[bid]['title'] = request.get_json()['title']
    return jsonify(books[bid])
print('PUT updates a resource')

Eliminazione con DELETE

DELETE rimuove una risorsa. In caso di successo, è comune restituire lo stato 204 No Content.

from flask import Flask, jsonify
app = Flask(__name__)
books = {1: {'id': 1, 'title': 'A'}}

@app.route('/api/books/<int:bid>', methods=['DELETE'])
def delete_book(bid):
    if bid in books:
        del books[bid]
        return '', 204
    return jsonify({'error': 'not found'}), 404
print('DELETE removes a resource')

L'importanza dei codici di stato

REST si basa sui codici di stato HTTP: 200 OK, 201 Created, 204 No Content, 400 Bad Request, 404 Not Found.

# 200 success
# 201 created
# 204 no content
# 400 bad request
# 404 not found
print('Use the right status code')

Convalida del corpo

Verifichi che i campi obbligatori siano presenti prima di creare la risorsa. Restituisca 400 con un messaggio di errore quando il corpo non è valido.

from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/api/books', methods=['POST'])
def create_book():
    data = request.get_json(silent=True) or {}
    if 'title' not in data:
        return jsonify({'error': 'title required'}), 400
    return jsonify(data), 201
print('Validate JSON before using it')

Risposte coerenti

Le API ben progettate restituiscono una struttura prevedibile, spesso racchiudendo dati ed errori nello stesso modo ogni volta, così i client possono farvi affidamento.

from flask import jsonify
# Success: {'data': {...}}
# Error:   {'error': 'message'}
# Keep the shape consistent across endpoints
print('Predictable shapes help clients')

Verifica rapida

Verifichi le proprie conoscenze sulle REST API.

Riepilogo

Ha creato un endpoint REST JSON.

jsonify() (oppure un dict restituito) produce risposte JSON
Associ i verbi HTTP alle operazioni: GET legge, POST crea, PUT aggiorna, DELETE rimuove
Restituisca codici di stato significativi come 201, 204, 400 e 404
Convalidi il corpo della richiesta e mantenga coerenti le risposte

Domande Frequenti

La lezione «Creare un endpoint REST» è gratuita?

Sì — il testo completo di «Creare un endpoint REST» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Python Academy, passa a CoddyKit PRO. Il corso Python Academy include 4 lezioni in totale.

Cosa imparerò in «Creare un endpoint REST»?

Restituire risposte JSON Eserciti Python Academy con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Python Academy?

Non è richiesta alcuna esperienza precedente. Python Academy su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 4 di 4.

Quanto tempo richiede la lezione «Creare un endpoint REST»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Python Academy?

Sì. Ogni lezione Python Academy include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

← Torna a Python Academy