For å kjøre koden må man ha python installeret og pip for å laste ned pakker. Kjør kommandoene
pip install pyodbc # Database koblingen
pip install fastapi # API bygge pakken
pip install python-dotenv # For automatisk lasting av eviorment variabler
pip install "uvicorn[standard]" # Denne burde komme med fastapi, men er greit å ha alikevel
pip install pydantic # Burdge også følge med fastapi og er for å annotere funksjoner og objekter
For å laste ned repoet åpne opp kommandolinjen og skriv:
git clone https://github.com/christian-gustad/api_demo.git
Du må fylle oprette en .env
fil der du fyller ut verdiene som er gitt i env_example
.
Dette eksempelet benytter seg av Frøy-databasen, og for å finne verdinene vi trenger så må man gå inn på secrets i Azure portal.
Deretter kan du kjøre må du kjøre webserveren med kommandoen:
uvicorn main:app --reload
API dokumentasjonen finner du her, og her tutorial som stegvis går igjennom funksjonaliteten. Vi begynner med å lage den enkleste tjenesten nemlig en GET
.
PYODBC er databasekoblings verktøyet og dokumentasjonen finner dere her,
curl -X POST http://127.0.0.1:8000/querywithbody/
-d '{"string_parameter": "test", "numeric_parameter": 12345}'