Backend-kehityksen asetukset

Tällä sivulla luetellaan vaiheet, jotka tarvitaan Gramps Web API -sovelluksen, Gramps Webin taustapalvelimen, kehittämisen aloittamiseksi.

Esivaatimukset

Suositeltu kehitysympäristö käyttää Visual Studio Codea devcontainerien kanssa. Tämä lähestymistapa luo esikonfiguroidun kehitysympäristön, jossa on kaikki tarvittavat työkalut. Aloittaaksesi tarvitset seuraavat ainesosat:

• Docker
• Visual Studio Code asennettuna Dev Containers -laajennuksella
• Git

Voit käyttää käyttöjärjestelmänä Linuxia, macOS:ää tai Windowsia.

Aloittaminen

1. Avaa Gramps Web API -varasto ja napsauta "fork"
2. Kloonaa forkattu varasto paikalliselle koneellesi Gitin avulla
3. Avaa kloonattu varasto Visual Studio Codessa. Kun sinua kehotetaan, valitse "Avaa uudelleen kontissa" tai avaa manuaalisesti komentoikkuna (Ctrl+Shift+P tai Cmd+Shift+P) ja valitse "Dev Containers: Uudelleenrakennus ja avaa uudelleen kontissa".

4. Odota, että devcontainer rakennetaan ja käynnistyy. Tämä voi kestää muutaman minuutin, erityisesti ensimmäisellä kerralla.

   Kun Dev Containerin rakentaminen on onnistunut, komento palauttaa:

   Successfully installed gramps-webapi-x.x.x.

   Info

   Uudelleenrakentaminen Visual Studio Codessa:

   • Jos olet kontissa, käytä "Uudelleenrakennus kontissa" komentoikkunassa.

   • Jos olet kansiorakenteessa (eli et ole kontissa), käytä "Uudelleenrakennus ja avaa uudelleen kontissa" komentoikkunassa.

Tehtävät

Jos muokkaat vain taustakoodia, sinun ei välttämättä tarvitse käynnistää verkkopalvelinta - yksikkötestit käyttävät Flask-testiasiakasta, joka mahdollistaa pyyntöjen simuloimisen API:lle ilman, että palvelimen tarvitsee olla käynnissä.

Kuitenkin palvelimen käynnistäminen on hyödyllistä, jos

• haluat kokeilla muutoksiasi oikeilla HTTP-pyynnöillä (katso manuaaliset kyselyt),
• haluat esikatsella muutosten vaikutusta koko Gramps Web -sovellukseen tai
• haluat myös tehdä samanaikaisia muutoksia etupäähän (katso etupään kehityksen asetukset).

Palvelimen käynnistäminen on yksinkertaistettu devcontainerissa ennalta määritellyillä tehtävillä. Voit suorittaa nämä tehtävät komentoikkunasta (Ctrl+Shift+P tai Cmd+Shift+P) valitsemalla "Tehtävät: Suorita tehtävä" ja sitten valitsemalla jonkin seuraavista: - "Palvelin Web API" - käynnistää Flaskin kehityspalvelimen portissa 5555 debug-lokitus käytössä - "Käynnistä Celery-työntekijä" - käynnistää Celery-työntekijän taustatehtävien käsittelyyn.

Virheenkorjaus

Virheenkorjaus voi joskus olla haastavaa, erityisesti monimutkaisen käyttäytymisen jäljittämisessä tai hienovaraisten ongelmien tunnistamisessa. Tämän helpottamiseksi voit virheenkorjata sekä käynnissä olevan API-instanssin että yksittäiset testitapaukset suoraan Visual Studio Codessa.

Gramps Web API:n virheenkorjaus

Virheenkorjataksesi käynnissä olevan API:n:

1. Avaa Visual Studio Code ja siirry Suorita ja virheenkorjaa -näkymään.
2. Valitse "Web API" -konfiguraatio pudotusvalikosta.
3. Aloita virheenkorjaus.
4. Kun lähetät pyyntöjä taustalle (manuaalisesti tai Gramps Web -käyttöliittymän kautta), suoritus pysähtyy kaikissa koodissa asettamissasi katkaisupisteissä.
   Tämä mahdollistaa muuttujien tarkastelun, ohjausvirran ja muiden ajonaikaisten yksityiskohtien tarkastelun.

Testitapausten virheenkorjaus

Virheenkorjataksesi tietyn testitapauksen:

1. Avaa testitiedosto, jota haluat virheenkorjata (esimerkiksi test_people.py).
2. Visual Studio Codessa avaa Suorita ja virheenkorjaa -näkymä.
3. Valitse "Nykyinen testitiedosto" -konfiguraatio.
4. Aloita virheenkorjaus — suoritus pysähtyy kaikissa katkaisupisteissä, jotka on asetettu kyseisessä testitiedostossa.

Tämä asetus mahdollistaa testilogiikan läpikäymisen, muuttujien arvojen tarkastelun ja testivirheiden tai odottamattomien tulosten paremman ymmärtämisen.