Javni API za pravljenje travel aplikacija (slanje, pretraga i brisanje lokacija).
Vidi: https://spomenici-api.herokuapp.com/
Svaki odgovor servera ima standardan JSON format:
{
"status": "success", // ili "error"
"data": {}, // ili null
"message": "Info poruka" // ili null
}
Vraca sve objekte. Umesto varijable naziv
, mozete uneti bilo koju postojecu kolekciju, npr:
URL ka slici objekta.
Vraca jedan objekat.
Vraća određen broj objekata po stranici. Na primer: /kolekcija/itfirme/strana/2
Poslednji parametar, broj predmeta poStrani
je opcion, a podrazumevano je 20.
Vraca sve kategorije po kolekciji.
Obavezna i opciona polja kada se šalje novi objekat:
{
naslov: String, // required
opis: String,
kategorija: String, // required
// geolokacija:
lat: Number, // required
lon: Number // required
slika: File,
website: String,
// radno vreme u formatu 0-24:
od: Number,
do: Number
}
Slika se salje serveru kao fajl.
Može se opciono azurirati bilo koje polje na osnovu id-a.
Obavezna polja: email, password i repeatPassword.
Nakon uspesne registracije vraca token u x-auth-token
polju u headeru.
Obavezna polja: email i password.
Nakon uspesne prijave vraca token u headeru kao odgovor.
Za svaki naredni ovlasceni zahtev u headeru slati polje x-auth-token
sa tokenom.
Vraca jednog korisnika
Opciono se azurira bilo koje polje.
Obavezno polje je email. Salje novu lozinku na email.
$ git clone https://github.com/skolakoda/spomenici-api.git
$ cd spomenici-api
$ npm install
Da bi aplikacija radila neophodno je napraviti .env
fajl i dodati sledece variable:
DB_URI
sa linkom ka MongoDB bazi (ili trazite kredencijale ili otvorite svoju na lokalu)DB_NAME
ime postojece ili novokreirane bazeNODE_ENV
sa vrednoscu "development"TOKEN_KLJUCH
iz heroku dashboard settings-a (ili bilo koji string za lokalni razvoj)
Konacno, kad dodate varijable okruzenja, pokrenite:
$ npm run dev
Ovaj projekat koristi kodni standard Škole koda.