›_ ebskola.lv
← 12.2 12.4 →

12.3 REST API izstrāde

Stundas uzdevums: Saprast REST principus un izveidot pareizi strukturētu API spēļu rezultātu pārvaldībai.

SR 2.4.11. Lieto standartizētas bibliotēkas un API SR 2.4.7. Lietotāja saskarne

70 min darba sadalījums: 1. uzdevums (~20 min) - atjauno teorijas piemēru vai minimālo prototipu; 2. uzdevums (~25 min) - pielieto to galvenajā uzdevumā; 3. uzdevums (~25 min) - pārbaudi rezultātu, izlabo kļūdas un tikai beigās pieraksti vienu secinājumu. Papildus/4. līmeņa uzdevums ir paredzēts tikai tad, ja pamatdarbs ir pabeigts.

Pirms sāc: izmanto iepriekš apgūto un šīs lapas teorijas/koda piemērus. Ja vajadzīga jauna komanda vai rīks, vispirms atrodi tās paraugu teorijas sadaļā.

Teorija: REST principi

REST (Representational State Transfer) ir API projektēšanas stils, kas nosaka:

MetodeURLDarbība
GET/api/speletajiSaraksts ar visiem
GET/api/speletaji/42Viens pēc ID
POST/api/speletajiIzveidot jaunu
PUT/api/speletaji/42Aizstāt visu
PATCH/api/speletaji/42Daļēji atjaunināt
DELETE/api/speletaji/42Dzēst

Pareizie statusa kodi: 200 OK, 201 Created, 204 No Content, 400 Bad Request, 401 Unauthorized, 404 Not Found, 500 Server Error.

Praktiskie uzdevumi

1. uzdevums - Iesildies ar gatavu piemēru

Šis ir īss iesildīšanās uzdevums. Nokopē sagatavi, ielīmē to pareizajā koda vietā un palaid. Šeit pietiek droši izmēģināt tēmu 12.3 REST API izstrāde; detalizētu izpratni veidosi nākamajos uzdevumos.

Kopējamais piemērs vai sagatave: izmanto šo bloku kā starta punktu, nevis kā gala risinājumu.

from flask import Flask, render_template

app = Flask(__name__)

@app.route("/")
def index():
    return render_template("index.html", temats="12.3 REST API izstrāde")

if __name__ == "__main__":
    app.run(debug=True)
<h1>{{ temats }}</h1>
<p>Ja redzi šo tekstu pārlūkā, iesildīšanās piemērs darbojas.</p>
  1. Atver darba failu vai rīku. Python daļu ievieto app.py, bet HTML daļu ievieto templates/index.html.
  2. Nokopē visu piemēra bloku no šī uzdevuma un ielīmē to norādītajā vietā.
  3. Palaid kodu tieši tādu, kāds tas ir, un pārliecinies, ka parādās rezultāts, izvade vai vismaz nav kļūdas paziņojuma.
  4. Atrodi vienu drošu vietu, ko drīkst mainīt: tekstu, skaitli, krāsu, mainīgā vērtību vai testa ierakstu.
  5. Maini tikai šo vienu vērtību un palaid kodu vēlreiz.
  6. Salīdzini rezultātu pirms un pēc izmaiņas. Ja parādās kļūda, atcel pēdējo izmaiņu un palaid vēlreiz.
  7. Turpini pie 2. uzdevuma tikai tad, kad šis mazais piemērs darbojas.

2. uzdevums - Ievieto algoritmu projektā

Pievieno šīs stundas paņēmienu kā nelielu, strādājošu projekta daļu.

  1. Izvēlies vienu vietu projektā: datu apstrādi, skatu, formu, API maršrutu, validāciju vai rezultāta izvadi.
  2. Nosauc funkcijas, mainīgos un failus pēc to lomas, piemēram, apstrada_gajienu(), rezultats vai routes.py.
  3. Uzraksti funkciju vai maršrutu, kas nolasa datus, apstrādā tos un atgriež rezultātu.
  4. Savieno šo kodu ar HTML formu, pogu, saiti, API pieprasījumu vai redzamu izvades vietu.
  5. Pievieno vienu īsu komentāru pie sarežģītākās apstrādes vietas.
  6. Pārbaudi, ka esošā projekta daļa joprojām darbojas.
  7. Salabo pirmo atrasto kļūdu pirms paplašini risinājumu.
  8. Veic Git commit ar īsu ziņu par pievienoto funkcionalitāti.

3. uzdevums - Testē kodu un izdari secinājumu

Pārbaudi, vai algoritms darbojas paredzami ar dažādiem datiem.

  1. Izveido trīs testa scenārijus: parastu ievadi, robežgadījumu un kļūdainu vai tukšu ievadi.
  2. Palaid parasto scenāriju un pārbaudi rezultātu pārlūkā, terminālī vai API atbildē.
  3. Palaid robežgadījumu ar mazāko, lielāko vai tukšāko vērtību, ko šis kods var saņemt.
  4. Palaid kļūdaino scenāriju un pārbaudi, vai lietotājs saņem saprotamu atbildi.
  5. Izlabo vienu konkrētu problēmu Python kodā, HTML sasaistē vai datu validācijā.
  6. Pārbaudi labojumu vēlreiz ar visiem trim scenārijiem.
  7. Beigās pieraksti vienu secinājumu: kura koda daļa vislabāk palīdzēja saprast tēmu 12.3 REST API izstrāde.

Papildu uzdevums - Pievieno mazu funkciju

Ja pamatdarbs ir pabeigts, paplašini projektu ar vienu nelielu programmētu uzlabojumu.

  1. Izvēlies vienu mazu papildinājumu, kas izmanto to pašu šīs stundas paņēmienu.
  2. Pievieno vienu jaunu ievades lauku, API atbildi, validāciju, datu elementu vai redzamu rezultātu.
  3. Savieno papildinājumu ar esošo projektu.
  4. Pārbaudi, ka pamatfunkcija un papildinājums darbojas kopā.
  5. Saglabā izmaiņas ar Git commit tikai pēc veiksmīgas pārbaudes.

Biežākās kļūdas

Koda piemērs

from flask import Flask, jsonify, request, abort

app = Flask(__name__)
REZULTATI = []

@app.route("/api/rezultati", methods=["GET"])
def saraksts():
    limit = request.args.get("limit", 100, type=int)
    sakartoti = sorted(REZULTATI, key=lambda r: r["punkti"], reverse=True)
    return jsonify(sakartoti[:limit])

@app.route("/api/rezultati", methods=["POST"])
def jauns():
    d = request.json or {}
    if not d.get("vards"): return jsonify({"kluda": "Trūkst vārds"}), 400
    if d.get("punkti", 0) < 0: return jsonify({"kluda": "Negatīvi punkti"}), 400
    d["id"] = len(REZULTATI) + 1
    REZULTATI.append(d)
    return jsonify(d), 201

@app.errorhandler(404)
def not_found(e):
    return jsonify({"kluda": "Nav atrasts"}), 404
POST → 201 Created
GET ?limit=5 → top 5
404 → {kluda: 'Nav atrasts'}
⬅ Iepriekšējā stunda Nākamā stunda ➡