Flask Academy · Oppitunti

Resource-luokat ja Api-olio

Mallinna endpointit verbejä käyttävinä resursseina.

Oppitunti 1/413 vaihetta

Resource-luokat ja Api-olio on ilmainen Flask Academy-oppitunti CoddyKitissä. Tämä on oppitunti 1/4. Voit lukea koko oppitunnin alta ilmaiseksi ja harjoitella sen jälkeen käytännössä selaimessa sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla. Oppitunti kuuluu Flask Academy-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. Flask Academy-kurssilla on yhteensä 4 oppituntia.

Selkeämpi tapa rakentaa API-rajapintoja

Tavalliset Flask-reitit toimivat, mutta API-rajapinnoissa Flask-RESTful tarjoaa siistin luokkapohjaisen rakenteen, joka skaalautuu päätepisteiden määrän kasvaessa. 🧩

Asenna laajennus

Flask-RESTful toimitetaan erillisenä pakettina. Lisätkää se projektiin pipillä ennen kuin importoitte siitä mitään.

pip install flask-restful

Tuo tarvittavat osat

Tarvitsette kaksi nimeä: Api, päätepisteet yhdistävä hallinnoija, sekä Resource, jokaisen resurssin kantaluokka.

from flask_restful import Api, Resource

Kääri sovellus Api-objektiin

Luokaa Flask-sovelluksen ympärille Api-objekti. Siitä tulee rekisteri, johon kaikki resurssit liitetään.

app = Flask(__name__)
api = Api(app)

Mikä Resource on

Resource on Python-luokka, joka edustaa yhtä API-rajapinnan asiaa, kuten tehtävää tai käyttäjää, yhdessä paikassa.

class HelloWorld(Resource):
    pass

Peri Resource

Jokainen rakentamanne päätepiste alkaa Resource-luokan perimisestä. Sen sisäiset metodit vastaavat HTTP-verbeihin.

class TaskList(Resource):
    def get(self):
        return {"tasks": []}

Liitä se URL-osoitteeseen

Liittäkää resurssiluokka URL-polkuun add_resource-funktiolla. Näin Api saa tietää, missä resurssi sijaitsee.

api.add_resource(TaskList, "/tasks")

Palauta tavallisia dictejä

Palauttakaa vain Pythonin dict, niin Flask-RESTful sarjallistaa sen JSONiksi puolestanne. Erillistä jsonify-funktiota ei tarvita. ✨

def get(self):
    return {"message": "hello"}

Ei enää reittidekoraattoreita

Huomatkaa, että jätitte @app.route-dekoraattorin kokonaan pois. Api-objekti ja add_resource korvaavat dekoraattoreihin perustuvan työnkulun.

Aja se kuten mikä tahansa Flask-sovellus

Käynnistys ei muutu: sama app.run tarjoaa resurssipohjaisen API-rajapinnan kehityspalvelimella.

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

Miksi luokat auttavat

Toisiinsa liittyvien verbien ryhmittely yhteen class-luokkaan pitää kunkin päätepisteen itsenäisenä ja tekee siitä paljon helpommin luettavan kuin hajallaan olevista funktioista.

Pikatarkistus

Mikä objekti yhdistää Resource-luokan URL-osoitteeseen?

Kertaus: Resurssit ja Api

Käärityitte sovelluksen Api-objektiin, peritte Resource-luokan ja liititte sen add_resource-funktiolla. Siinä on siisti API-runkonne! 🎉

Aloita maksutta

Opi Python tekoälytuutorin avulla — ilmaiseksi

Kirjoita ja suorita oikeaa koodia selaimessa, saa välitöntä apua tekoälytuutorilta ympäri vuorokauden ja jatka siitä, mihin jäit, verkossa tai sovelluksessa.

Kurssit
30
Oppitunnit
120

Usein kysytyt kysymykset

Onko oppitunti ”Resource-luokat ja Api-olio” ilmainen?

Kyllä – oppitunnin ”Resource-luokat ja Api-olio” koko tekstin voi lukea täällä verkossa ilmaiseksi. Jos haluat harjoitella interaktiivisesti sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla sekä avata koko Flask Academy-kurssin, päivitä CoddyKit PROhon. Flask Academy-kurssilla on yhteensä 4 oppituntia.

Mitä opin oppitunnilla ”Resource-luokat ja Api-olio”?

Mallinna endpointit verbejä käyttävinä resursseina. Harjoittelet Flask Academy-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.

Tarvitsenko kokemusta aloittaakseni Flask Academy-opiskelun?

Aiempi kokemus ei ole tarpeen. CoddyKitin Flask Academy-oppimispolku sopii vasta-alkajista edistyneisiin, joten voit aloittaa tästä tai alusta ja edetä omaan tahtiisi. Tämä on oppitunti 1/4.

Kuinka kauan ”Resource-luokat ja Api-olio”-oppitunnin suorittaminen kestää?

Useimmat CoddyKitin oppitunnit kestävät noin 5–10 minuuttia. Jokainen oppitunti on lyhyt ja interaktiivinen, joten edistyt tasaisesti ja voit jatkaa siitä, mihin jäit – sekä verkossa että sovelluksessa.

Voinko kirjoittaa ja suorittaa koodia tällä Flask Academy-oppitunnilla?

Kyllä. Jokainen Flask Academy-oppitunti sisältää sisäänrakennetun koodieditorin, joten voit kirjoittaa ja suorittaa oikeaa koodia suoraan selaimessa ja saada välitöntä palautetta tekoälyltä – paikallista asennusta ei tarvita.

Kaikki tämän kurssin oppitunnit

  1. Resource-luokat ja Api-olio
  2. Yhdistä HTTP-metodit luokkakäsittelijöihin
  3. Jäsennä ja validoi reqparsella
  4. Blueprintiin liitetyt REST-resurssit
← Takaisin: Flask Academy