Tässä luvussa tarkastelemme tarkemmin projektin rakennetta. Hyvin organisoidun rakenteen ylläpitäminen on olennaista koko sovelluksen kehityksen aikana. Alla esitellään keskeiset kansiot ja tiedostot, joita projektissamme kohtaamme:

Projektin aloitustiedostot

Voit tarkastella projektin alkuperäisiä tiedostoja ja kansioita osoitteessa Github Jos GitHub on sinulle uusi, seuraa alla esitettyä yksinkertaista kaksivaiheista ohjetta ladataksesi projektin.

Projektirakenteen yleiskatsaus

Tarkastellaan kunkin kansion ja tiedoston tarkoitusta. Alla oleva kuva havainnollistaa projektin rakennetta visuaalisesti:

Seuraavaksi tarkastellaan kunkin hakemiston ja tiedoston tarkoitusta:

1. index.js: Sovelluksen pääasiallinen käynnistyspiste. Tässä tiedostossa määritellään Express-palvelin, konfiguroidaan middlewaret, määritellään reitit ja käynnistetään palvelin;

   • Express-sovelluksen alustaminen;
   • Middlewarejen, kuten express.json(), konfigurointi JSON-pyyntöjen jäsentämistä varten;
   • Reittien ja virheenkäsittelymiddlewarejen määrittely;
   • Express-palvelimen käynnistäminen määritellyssä portissa (esim. 3000).

2. routes/: Tämä hakemisto sisältää eri API-päätepisteiden reittimäärittelyt. Reittien jakaminen omiin moduuleihin pitää koodipohjan selkeänä;

   • Erillisten reittitiedostojen luominen eri toiminnoille (esim. käyttäjien hallinta, twiitit, julkaisut, autentikointi);
   • Reittien käsittelykoodin organisointi ja modulaarisuus.

3. routes/postsRoutes.js: Käsittelee erityisesti sovelluksen julkaisuihin (twitteihin) liittyvät reitit;

   • Reittien määrittely julkaisujen (twittien) luomista, hakemista, päivittämistä ja poistamista varten;
   • Vuorovaikutuksen hallinta posts.json-datatiedoston kanssa.

4. middlewares/: Tässä hakemistossa olevat middleware-funktiot ovat olennaisia erilaisiin tehtäviin, kuten validointiin, autentikointiin ja valtuutukseen. Ne edistävät koodin uudelleenkäytettävyyttä;

   • Middleware-funktioiden erottelu omiin moduuleihinsa;
   • Middlewarejen käyttö esimerkiksi datan validointiin, käyttäjän autentikointiin ja virheenkäsittelyyn.

5. middlewares/validateData.js: Tämä middleware-funktio keskittyy saapuvien pyyntöjen datan validointiin. Se varmistaa, että lähetetty data täyttää vaaditut kriteerit;

   • Saapuvan datan tarkastelu oikeellisuuden varmistamiseksi ennen käsittelyä;
   • Sopivat virhevastausviestit virheellisen tai puuttuvan datan tapauksessa.

6. database/: Tämä hakemisto sisältää sovelluksen tietovaraston;

7. database/posts.json: Tässä tiedostossa tallennetaan data - tässä tapauksessa julkaisut - JSON-muodossa;

8. node_modules/: Luodaan automaattisesti, kun suoritetaan npm i express. Tämä hakemisto sisältää kaikki projektissa käytetyt ulkoiset kirjastot ja moduulit;

9. package.json ja package-lock.json: Nämä tiedostot listaavat kaikki projektin riippuvuuksina olevat paketit.