api-excercise

Przykładowe api, korzystające z mongodb

Dane potrzebne do połączenia się należy uzupełnić w pliku .env

Posiada 8 prostych endpointów:

• get/user
• post/user
• post/item
• delete/item
• get/itemIndex (przy użyciu indexu)
• get/itemMessage (przy użyciu zawratości)
• put/itemID

pipenv

Zależności

Za pomocą Pipfile/Pipfile.lock i PipEnv z łatwością można zainstalować wszystkie zależności projektu

pipenv install --version - aby sprawdzić wersję/czy jest zainstalowany

pip install pipenv - Instalacja pipenv za pomocą pip

Uruchamianie

Przed rozpoczeciem uruchamiania uzupełniamy dane do połączenia się z MongoDB w pliku .env który można utworzyć na podstawie .env.example

pipenv install - instalujemy wszystkie moduły

uvicorn api:app - uruchamiamy webserver

Gotowe, teraz api działa na socketcie 127.0.0.1:8000

Można go używać przy pomocy curl lub przeglądarki

Dokumentacja wygenerowana przez FastApi: 127.0.0.1/redoc

Docker

Przed tworzeniem obrazu należy stworzyc plik .env na podstawie .env.example