Storm IT
Wróć do bloga
Java12 czerwca 2024

Spring Boot, Spring REST API

Spring Boot, Spring REST API

Spring Boot, Spring REST API

Jak za pomocą Javy, Mavena, SpringBoot'a stworzyć proste API REST-owe?

Z tego materiału dowiesz się:

  • Jak utworzyć nowy projekt w IntelliJ IDEA za pomocą Spring Initializer?
  • Jak skonfigurować projekt Maven ze Spring Boot?
  • Jakie są podstawowe zależności potrzebne do stworzenia API RESTowego?
  • Jak zorganizować strukturę katalogów w projekcie Spring Boot?
  • Jak utworzyć prostą klasę kontrolera REST w Spring Boot?
  • Jak uruchomić aplikację Spring Boot i przetestować jej działanie?
  • Jak mapować metody kontrolera na odpowiednie żądania HTTP?
  • Jakie są zalety wersjonowania API i jak je zaimplementować?
  • Jak sprawdzić poprawność działania aplikacji za pomocą przeglądarki?

Tworzenie Nowego Projektu

Rozpoczynamy od utworzenia nowego projektu w IntelliJ IDEA. Możesz to zrobić przez File -> New -> Project. Jeśli masz pełną wersję, skorzystaj ze Spring Initializer. Alternatywnie, użyj strony StartSpring.io.

→ ZOBACZ👉: IDE Zintegrowane środowisko programistyczne | Kurs Java

Konfiguracja Projektu

  1. Wybór lokalizacji: Wybierz, gdzie chcesz utworzyć nowy projekt.
  2. Nazwa projektu i pakietu: Określ nazwę projektu oraz główny pakiet.
  3. Wersja Javy: Pracujemy na wersji Java 21, z pakowaniem jar.
  4. Wybór zależności: Dodaj Spring Web – na początek wystarczy.

Struktura Projektu

Projekt utworzony! Zajrzyjmy do pliku pom.xml w głównym katalogu – to tutaj znajdziesz wszystkie zależności. Pamiętaj, że pierwsze uruchomienie może chwilę potrwać, gdyż muszą się pobrać wszystkie potrzebne zasoby.

→ ZOBACZ👉: Spring Boot i wstrzykiwanie zależności – szybkie wprowadzenie

Katalogi

  • src/main: Zawiera źródła aplikacji.
  • src/test: Znajdziesz tu testy, które warto uruchomić, aby sprawdzić, czy wszystko działa poprawnie.

Tworzenie Kontrolera REST

Stwórz nową klasę, np. StormResources, i dodaj metodę zwracającą aktualny czas:

@RestController
@RequestMapping("/api/v1")
public class StormResources {
    @GetMapping("/test")
    public String testReturn() {
        return "Current time: " + System.currentTimeMillis();
    }
}

Adnotacja @RestController informuje Spring, że jest to kontroler RESTowy. Metoda testReturn zwraca ciąg znaków z aktualnym czasem.

Uruchomienie Aplikacji

Uruchom aplikację, a następnie sprawdź w przeglądarce adres http://localhost:8080/api/v1/test. Jeśli zobaczysz zmieniające się liczby, to znak, że wszystko działa poprawnie!

→ ZOBACZ👉: Spring Boot i wstrzykiwanie zależności – szybkie wprowadzenie

Mapowanie metod HTTP

Skorzystaj z adnotacji takich jak @GetMapping, aby przypisywać metody kontrolera do konkretnych żądań HTTP, co pozwala na obsługę różnych typów zapytań (GET, POST, itp.).

Wersjonowanie API

Korzystamy z wersjonowania API, co ułatwia zarządzanie zmianami w przyszłości, i dodaję wersję do ścieżki URL swojego API przy użyciu adnotacji @RequestMapping.

Sprawdzenie poprawności działania aplikacji za pomocą przeglądarki

Uruchamiamy aplikację i testujemy jej działanie poprzez wpisanie odpowiedniego adresu URL w przeglądarce, co pozwala na szybką weryfikację, czy aplikacja działa poprawnie.

Podsumowanie

Gratulacje, w ten sposób właśnie powstaje API RESTowe! Jeśli chcesz dalej rozwijać swoje umiejętności w Javie, zapraszam na stronę

👉: Kurs Java

gdzie znajdziesz więcej materiałów.

Zobacz więcej wpisów