Skip to content

Latest commit

 

History

History
367 lines (298 loc) · 10.7 KB

Backend_instructions.md

File metadata and controls

367 lines (298 loc) · 10.7 KB
Raw

Backend

Setup:

I terminalen:

  • Kjør pip install pipenv
  • Kjør pipenv shell
  • Kjør pipenv install
  • cd til "backend"
  • Kjør python manage.py makemigrations
  • Kjør python manage.py migrate (oppdaterer databasen)

Kjøre server

I terminalen:

  • cd til "backend"
  • Kjør python manage.py runsever

Problem med server/migrations:

  • Slett migrations-mappen i marketplace og slett databasefilen db.sqlite3
  • Kjør python manage.py makemigrations og python manage.py migrate

Lage en json-fil med nåværende data i databasen:

  • Kjør python manage.py dumpdata --format=json marketplace > demodata.json
  • For å laste inn data fra json-filen igjen: python manage.py loaddata demodata.json

Hvordan gjøre http requests

Forsikre deg om at databasen er oppdatert med å kjøre python manage.py migrate

Med postman:

-Last ned postman fra https://www.postman.com/downloads/

Opprette en bruker

{
  "username": "bruker",
  "phone": "12345678",
  "first_name": "F_navn",
  "last_name": "E_navn",
  "email": "[email protected]",
  "password": "passord123",
  "re_password": "passord123"
}

Dersom alt gikk som det skal, får du

{
    "username": "bruker",
    "phone": "12345678",
    "first_name": "F_navn",
    "last_name": "E_navn",
    "email": "[email protected]",
    "id": 1,
    "is_blocked": false
    "is_staff": false
}

Og en http melding 201 Created

Logge inn / lage en token

{
  "email": "[email protected]",
  "password": "passord"
}
  • Dersom alt gikk som det skal, får du en refresh og en access token.
{
  "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTU4MjY2NzEwMywianRpIjoiMDMxZDI0MjAyMDg1NGFmYTgyOGRhYTRiYTIzMWY3Y2IiLCJ1c2VyX2lkIjoxfQ.gMaUzhQ8mmHLQ5jt1MnB0jovyl77macgbU83u15w7ms",
  "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNTgyNTgxMDAzLCJqdGkiOiJiZjI2NjhhMWRkZTM0NDFkYjcyNDEzNDBkNjJjMTMwNiIsInVzZXJfaWQiOjF9.FAL2ZQEBXaafAyFVAJn_BRp4z2EhZ7ZIybtiHTMW-XU"
}

  • Access token varer en kort periode, og kan oppdateres ved å sende en post request til http://localhost:8000/auth/jwt/refresh

  • I "Headers" velg key = Content-Type og Value = application/json

  • I "Body" skriv

{
  "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTU4MjY2NzEwMywianRpIjoiMDMxZDI0MjAyMDg1NGFmYTgyOGRhYTRiYTIzMWY3Y2IiLCJ1c2VyX2lkIjoxfQ.gMaUzhQ8mmHLQ5jt1MnB0jovyl77macgbU83u15w7ms"
}
  • Da skal du få tilbake en ny access token
{
  "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNTgyNTgxMTg5LCJqdGkiOiIzNDQ3ZWE1ZWNiY2U0OTE3ODE4ZjJjZWRkMTI5YjkyMiIsInVzZXJfaWQiOjF9.L3gEVnsLX05spHt8VX954ue4_669rg8ERleTkn9RKHM"
}

Request som krever token-autentisering:

  • De neste requestene krever at du har en gyldig token i header. Dette kan gjøres slik:
  • I authorization-parameter, velg "bearer token", og lim inn en gyldig token

Få tak i / endre på innlogget bruker:

{
    "username": "josteiht",
    "phone": "9874565",
    "first_name": "Jostein",
    "last_name": "Tysse",
    "id": 1,
    "email": "[email protected]",
    "is_staff": true,
    "is_blocked": false
}
  • For å endre på info, velg PUT-request, og skriv inn endringene du vil gjøre på samme måte som når man lager en bruker. Alle felt trenger ikke deklareres, kun username og email.

Endre en annen bruker*:

Få tak i en liste av alle brukere (som admin*):

Admin actions:

Blokkere bruker:

{
    "username" : "*brukernavn*",
    "is_blocked" : "true"
}
  • Vet ikke hvorfor, men username må være med.

Gjøre bruker til admin:

{
  "username" : "*brukernavn*",
  "is_admin" : "true"
}
  • Du kan også endre på alle de andre feltene til brukeren når du har admin-tilgang (ikke ID). Her er alle feltene en bruker har:
{
    "username": "brukernavn",
    "phone": "12345567",
    "first_name": "F_navn",
    "last_name": "E_navn",
    "email": "[email protected]",
    "id": 2,
    "is_staff": false,
    "is_blocked": false,
    "password": "passord",
    "re_password": "passord en gang til"
}
  • For å endre på info (kan ikke endre e-mail), velg PUT-request, og skriv inn endringene du vil gjøre på samme måte som når man lager en bruker. Alle felt trenger ikke deklareres, kun username.

Endre en annen bruker*:

Få tak i en liste av alle brukere:

Få opp liste med annonser

[
    {
        "id": 1,
        "title": "Test",
        "creator": 1,
        "price": 1000,
        "description": "Look: a thing!",
        "creation_date": "2020-03-11",
        "img": "http://127.0.0.1:8000/media/images/Danseshow2018_1.JPG"
    },
    {
        "id": 2,
        "title": "Dette er en test",
        "creator": 5,
        "price": 1000,
        "description": "Vær så snill å funk!",
        "creation_date": "2020-03-11",
        "img": "http://127.0.0.1:8000/media/images/Danseshow2019_4.JPG"
    }
]

Poste en annonse

  • Sett URL http://127.0.0.1:8000/api/marketplace/saleItems/
  • Velg POST request
  • Krever token-autentisering (Se over)
  • Under headers velg Key = Content-Type, Value = multipart/form-data
  • Under body kryss av form-data
  • Skriv inn key values (en på hver rad): title, creator, price, description, img (creator refererer til brukerID)
  • For alle felt bortsatt fra img kan man bare skrive inn informasjonen som tekst inn i Value feltet
  • For img holder man musen over høyre side av Key feltet, og får opp en dropdown meny hvor man kan endre fra Text til File
  • (img kan også være null, kan da skrive som tekst)
  • Deretter trykker man Select files og velger bildet man vil ha med. Man skal da få tilbake en HTTP melding 201 Created og informasjon om posten på dette formatet:
{
    "id": 3,
    "title": "Test3",
    "creator": 5,
    "price": 10,
    "description": "Yo",
    "creation_date": "2020-03-11",
    "img": "http://127.0.0.1:8000/media/images/Danseshow2018_1_v3EFuv5.JPG"
}

For noen pekere på hvordan man gjør dette i React se nederst på denne siden: https://medium.com/@emeruchecole9/uploading-images-to-rest-api-backend-in-react-js-b931376b5833

Endre annonse

  • Sett URL http://127.0.0.1:8000/api/marketplace/saleItems/x/ (x er id til annonsen man vil endre)
  • Velg PUT
  • Krever token-autentisering (Se over)
  • Under headers sett Key = Content-Type, Value = multipart/form-data
  • Under body skriv inn fields man vil endre (title, creator og description må være med)
  • Man skal få opp info om posten som vist under Poste en annonse

Slette annonse

I nettleseren:

Lage annonse

Headers: 'content-type': 'mulitpart/form-data' URL: http://127.0.0.1:8000/api/marketplace/saleItems/

fields:

  • title
  • creator //id
  • price
  • description
  • img //legg til image, image.name. Kan være null

Se nederst på: https://medium.com/@emeruchecole9/uploading-images-to-rest-api-backend-in-react-js-b931376b5833

evt. uten img:

{
    "title": "123"
    "creator": 1
    "price": 100
    "description": "456"
    "img": null
}

Finne annonser

URL: http://127.0.0.1:8000/api/marketplace/saleItems/

eksempel på et entry:

{
  "id": 1,
  "title": "Test",
  "creator": 1,
  "price": 50000,
  "description": "Dette er en test",
  "creation_date": "2020-02-26",
  "img": "http://127.0.0.1:8000/media/images/Prosjekt_ER1.png"
}

Søke på annonser med kodeord

URL: GET http://127.0.0.1:8000/api/marketplace/saleItems?search=kodeord Her vil man få alle annonser som har "kodeord" i title, description, creator_username, creator_email, creator_last_name, creator_first_name

f.eks på søk: GET http://127.0.0.1:8000/api/marketplace/saleItems?search=hallo123

[
    {
        "id": 6,
        "title": "hallo1234",
        "creator": 3,
        "price": 100,
        "description": "This is a file",
        "creation_date": "2020-03-11",
        "img": null
    },
    {
        "id": 4,
        "title": "hallo1234",
        "creator": 3,
        "price": 100,
        "description": "This is a file",
        "creation_date": "2020-03-11",
        "img": null
    },
    {
        "id": 3,
        "title": "hallo1234",
        "creator": 3,
        "price": 100,
        "description": "This is a file",
        "creation_date": "2020-03-11",
        "img": null
    }
]