Ustvarjanje REST API z Flask-om: Preprosti primeri za začetnike

Flask je ena izmed najbolj priljubljenih in enostavnih Python ogrodij za ustvarjanje spletnih aplikacij in API-jev. V tem članku bomo raziskali, kako ustvariti REST API z uporabo Flask-a. Začeli bomo z osnovami, nato pa bomo postopoma dodajali funkcionalnosti, ki vam bodo omogočile, da boste ustvarili svoj lastni API. Če ste začetnik in želite izvedeti, kako deluje REST API, ste na pravem mestu!

Kaj je REST API?

REST (Representational State Transfer) je arhitekturni slog, ki se uporablja za razvoj spletnih storitev. API (Application Programming Interface) pa je niz pravil, ki omogočajo različnim programskim aplikacijam, da komunicirajo med seboj. REST API omogoča enostavno izmenjavo podatkov med strežniki in odjemalci, kjer so podatki običajno v formatu JSON.

Ko uporabljamo REST API, pošiljamo zahteve na strežnik, ki nato vrne podatke v želenem formatu. Na primer, lahko pošljete GET zahtevo za pridobivanje podatkov, POST zahtevo za dodajanje novih podatkov, PUT za posodabljanje obstoječih podatkov in DELETE za odstranjevanje podatkov. To so osnovne operacije, ki jih bomo uporabljali pri delu z našim Flask API-jem.

Zakaj izbrati Flask za ustvarjanje REST API?

Flask je mikrosistem, kar pomeni, da je enostaven za uporabo in omogoča hitro razvijanje aplikacij. Za razliko od drugih ogrodij, kot je Django, Flask ne nalaga preveč omejitev, kar vam omogoča večjo prilagodljivost pri gradnji API-jev. To je še posebej koristno za manjše projekte in za tiste, ki šele začenjate s spletnim razvojem.

Flask je tudi zelo lahkoten in omogoča hitro ustvarjanje in preizkušanje API-jev, kar pomeni, da lahko hitro začnete delati na svojih projektih in se osredotočite na funkcionalnosti, ki jih potrebujete. Poleg tega Flask omogoča enostavno integracijo z drugimi knjižnicami in orodji, kot so SQLAlchemy za delo z bazami podatkov, kar je lahko zelo koristno pri gradnji kompleksnejših API-jev.

Prvi koraki pri ustvarjanju REST API z Flask-om

Da bi začeli ustvarjati svoj REST API, potrebujemo le nekaj preprostih korakov. Predpostavimo, da imate že nameščen Python na svojem računalniku. Če tega še niste storili, lahko najdete navodila za namestitev Pythona na uradni spletni strani.

1. Namestitev Flask-a

Za začetek bomo namestili Flask. To lahko storite z uporabo PIP-a (Python Package Installer). Preprosto odprite terminal in zaženite naslednji ukaz:

pip install flask

2. Prvi primer: Enostaven REST API

Zdaj, ko imamo nameščen Flask, bomo ustvarili osnovni REST API. Ta API bo imel eno preprosto funkcionalnost: vrnil bo pozdravno sporočilo, ko bomo poslali GET zahtevo na naš strežnik.

Najprej ustvarite novo datoteko z imenom `app.py` in vnesite naslednjo kodo:

from flask import Flask

app = Flask(__name__)

@app.route('/hello', methods=['GET'])
def hello_world():
    return 'Pozdravljen, svet!'

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

V tem primeru smo ustvarili preprost Flask strežnik, ki ima eno pot `/hello`. Ko pošljemo GET zahtevo na to pot, strežnik vrne besedilo "Pozdravljen, svet!". Lahko zaženete to datoteko tako, da v terminalu vnesete:

python app.py

Ko zaženete aplikacijo, lahko obiščete `http://127.0.0.1:5000/hello` v svojem brskalniku, da preverite, ali vse deluje pravilno. Na tej poti boste videli sporočilo "Pozdravljen, svet!"

3. Dodajanje POST zahteve

Zdaj, ko imamo osnovni GET API, bomo dodali POST zahtevo. To bomo naredili tako, da bomo omogočili uporabnikom, da pošljejo podatke na strežnik in jih obdelamo. Na primer, ustvarili bomo API, ki sprejema ime uporabnika in vrne pozdravno sporočilo, ki vključuje to ime.

Posodobimo našo kodo v datoteki `app.py`:

from flask import Flask, request

app = Flask(__name__)

@app.route('/greet', methods=['POST'])
def greet_user():
    data = request.get_json()
    name = data.get('name', 'Svet')
    return f'Pozdravljen, {name}!'

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

V tem primeru smo dodali novo pot `/greet`, ki sprejema POST zahteve. Podatki morajo biti poslani v formatu JSON, kjer je ključ `name`. Na primer, lahko pošljemo naslednje podatke:

{
    "name": "Janez"
}

To bo povzročilo, da bo strežnik vrnil sporočilo "Pozdravljen, Janez!". Da bi preizkusili to funkcionalnost, lahko uporabite orodje, kot je Postman ali pa uporabite ukaz `curl` v terminalu:

curl -X POST -H "Content-Type: application/json" -d '{"name": "Janez"}' http://127.0.0.1:5000/greet

To bo poslalo POST zahtevo strežniku, ki bo vrnil odgovor "Pozdravljen, Janez!".

4. Obdelava napak

Pri delu z API-ji je pomembno, da obravnavamo napake, ki se lahko pojavijo med obdelavo zahtev. Na primer, kaj se zgodi, če uporabnik pošlje napačne ali nepopolne podatke? Za obvladovanje napak bomo dodali nekaj osnovnih preverjanj v naš API, da zagotovimo, da bodo vsi podatki pravilni.

Posodobimo naš API z obdelavo napak:

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/greet', methods=['POST'])
def greet_user():
    try:
        data = request.get_json()
        name = data['name']
        return jsonify({"message": f'Pozdravljen, {name}!'}), 200
    except KeyError:
        return jsonify({"error": "Manjka parameter 'name'!"}), 400

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

V tem primeru smo dodali obdelavo napak, ki preverja, ali je v podatkih prisoten ključ `name`. Če ni, API vrne napako z ustreznim sporočilom.

Zaključek

V tem članku smo ustvarili osnovni REST API z uporabo Flask-a. Preučili smo, kako obdelati GET in POST zahteve, ter kako obravnavati napake. Flask je odličen okvir za ustvarjanje preprostih, a zmogljivih API-jev, ki vam omogočajo, da hitro začnete s spletnim razvojem. Zdaj, ko imate osnovno razumevanje REST API-ja, lahko začnete graditi še bolj kompleksne in uporabne aplikacije!