PyCharm FastAPI – Tworzymy Super Szybkie API w Pythonie!

Chcesz stworzyć szybkie, nowoczesne API w Pythonie? PyCharm i FastAPI to idealne połączenie! Jeśli nigdy wcześniej nie pracowałeś z FastAPI, ten artykuł jest dla Ciebie. W prostych krokach pokażę, jak skonfigurować środowisko w PyCharm, zbudować API i uruchomić je. Gotowy na przygodę z nowoczesnym Pythonem? Zaczynamy!

Co To Jest FastAPI?

FastAPI to framework do tworzenia API w Pythonie, który zdobył ogromną popularność dzięki swojej szybkości, łatwości użycia i automatycznemu generowaniu dokumentacji API. Działa na bazie Starlette (szybka, asynchroniczna framework dla Pythona) i Pydantic (do walidacji danych), co sprawia, że jest jednym z najszybszych frameworków do tworzenia aplikacji webowych w Pythonie.

FastAPI automatycznie generuje dokumentację API (OpenAPI i JSON Schema), co jest ogromnym plusem dla programistów. Dzięki temu możesz szybko tworzyć skalowalne aplikacje webowe, które są zgodne z najnowszymi standardami, jednocześnie dbając o wydajność.

Dlaczego Wybrać FastAPI?

Oto kilka powodów, dla których warto wybrać FastAPI do budowania API:

• Wydajność – FastAPI jest jednym z najszybszych frameworków, które można wykorzystać do budowania API w Pythonie, co czyni go świetnym wyborem do aplikacji o dużym obciążeniu.
• Łatwość użycia – PyCharm oraz FastAPI to połączenie, które upraszcza proces tworzenia API. Automatyczna dokumentacja, walidacja danych, wsparcie dla typów danych, asynchroniczność – to wszystko sprawia, że praca staje się prostsza.
• Automatyczna dokumentacja – FastAPI generuje dokumentację API na podstawie typów danych i adnotacji, dzięki czemu nie musisz pisać jej ręcznie.
• Asynchroniczność – FastAPI w pełni wspiera asynchroniczność, co czyni go idealnym do tworzenia skalowalnych aplikacji webowych.

Instalacja PyCharm i FastAPI

Zanim zaczniemy kodować, musimy upewnić się, że mamy odpowiednie środowisko. Oto jak zainstalować FastAPI i skonfigurować PyCharm:

Instalacja FastAPI i Uvicorn

FastAPI działa w połączeniu z Uvicorn, serwerem ASGI (Asynchronous Server Gateway Interface). Zainstalujmy je za pomocą pip:

pip install fastapi uvicorn

Uvicorn jest bardzo szybkim serwerem, który obsługuje asynchroniczne zapytania. Jest to świetne narzędzie do uruchamiania aplikacji stworzonych za pomocą FastAPI.

Tworzenie Projektu w PyCharm

Teraz przejdźmy do PyCharm. Jeśli nie masz jeszcze PyCharm, pobierz go z oficjalnej strony PyCharm. Zainstaluj PyCharm, a potem wykonaj następujące kroki, aby utworzyć nowy projekt:

1. Uruchom PyCharm i wybierz "Create New Project".
2. Wybierz interpreter Pythona i utwórz nowe środowisko wirtualne.
3. W oknie terminala PyCharm zainstaluj FastAPI i Uvicorn (tak jak pokazano wcześniej).
4. Stwórz nowy plik, np. main.py, w którym będziesz pisać kod API.

Prosty Przykład API z FastAPI

Teraz stworzymy prostą aplikację API w FastAPI. Za pomocą tego przykładu nauczysz się podstawowych funkcji frameworka.

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"message": "Witaj w FastAPI!"}

W tym przykładzie tworzymy podstawową aplikację, która nasłuchuje na zapytanie GET na ścieżce głównej („/”) i zwraca odpowiedź z wiadomością „Witaj w FastAPI!”.

Uruchamianie Aplikacji

Aby uruchomić aplikację, użyjemy Uvicorn. W terminalu PyCharm wpisz:

uvicorn main:app --reload

Parametr --reload sprawia, że aplikacja będzie automatycznie przeładowywana, gdy zmienimy kod. Teraz wystarczy przejść do przeglądarki i wpisać:

http://127.0.0.1:8000

Powinieneś zobaczyć wiadomość: {"message": "Witaj w FastAPI!"}.

Dodawanie Parametrów do Endpointów

FastAPI pozwala na łatwe dodawanie parametrów do zapytań. Sprawdźmy, jak to zrobić, tworząc endpoint, który przyjmuje parametry URL:

@app.get("/items/{item_id}")
def read_item(item_id: int, query: str = None):
    return {"item_id": item_id, "query": query}

W tym przykładzie dodajemy parametr item_id, który jest wymagany w URL, oraz parametr opcjonalny query, który może być przekazany jako parametr zapytania (np. ?query=test).

Dokumentacja Automatyczna z FastAPI

Jedną z najfajniejszych rzeczy w FastAPI jest to, że automatycznie generuje dokumentację API na podstawie twojego kodu. Po uruchomieniu aplikacji, wejdź na adres:

http://127.0.0.1:8000/docs

Znajdziesz tam interaktywną dokumentację, która pozwoli ci testować różne endpointy bezpośrednio w przeglądarce.

Podsumowanie

PyCharm i FastAPI to fantastyczne połączenie, które pozwala na szybkie tworzenie API w Pythonie. Dzięki łatwej konfiguracji, dokumentacji i asynchronicznej obsłudze zapytań, FastAPI staje się jednym z najlepszych narzędzi do tworzenia nowoczesnych aplikacji webowych. Mam nadzieję, że ten artykuł pomógł Ci zrozumieć, jak zacząć przygodę z FastAPI i jak zbudować pierwsze API w Pythonie.

Jeśli masz jakiekolwiek pytania, śmiało pytaj w komentarzach! A jeśli chcesz dowiedzieć się więcej, na pewno pojawią się kolejne artykuły z przykładowymi rozwiązaniami w FastAPI.