Jetpack Compose Academy · Lekcja

Definiowanie interfejsu API Retrofit

Deklaruj endpointy za pomocą adnotacji

Lekcja 1 z 413 kroki

Definiowanie interfejsu API Retrofit to bezpłatna lekcja Jetpack Compose Academy na CoddyKit. To lekcja 1 z 4. Możesz przeczytać całą lekcję poniżej za darmo — a potem ćwiczyć ją interaktywnie w przeglądarce z wbudowanym edytorem kodu i tutorem AI dostępnym 24/7. To część ścieżki edukacyjnej Jetpack Compose Academy, a Twój postęp synchronizuje się między webem a aplikacją CoddyKit. Kurs Jetpack Compose Academy zawiera 4 lekcji w sumie.

Działanie Retrofit

Retrofit zamienia zwykły interfejs Kotlin w działającego klienta HTTP, dzięki czemu wystarczy opisać API, a kod komunikacji sieciowej zostanie wygenerowany automatycznie.

Wszystko zaczyna się od interfejsu

Każdy endpoint deklaruje się jako funkcję wewnątrz kotlinowego interface. Retrofit odczytuje adnotacje i w czasie działania tworzy rzeczywistą implementację.

interface UserApi {
    // endpoint functions go here
}

Oznacz żądanie GET

Adnotacja @GET informuje Retrofit, że ta funkcja pobiera dane. Przekazuje się jej ścieżkę znajdującą się za bazowym adresem URL. 🌐

@GET("users")
fun getUsers(): Call<List<User>>

Także POST, PUT i DELETE

Oprócz GET Retrofit udostępnia @POST, @PUT i @DELETE, dzięki czemu jeden interfejs może odczytywać i zapisywać dane na serwerze.

@POST("users")
fun createUser(@Body user: User): Call<User>

Parametry ścieżki

Użyj @Path, aby wstawić wartość do adresu URL. Retrofit zastępuje nazwany symbol zastępczy w nawiasach klamrowych przekazanym argumentem.

@GET("users/{id}")
fun getUser(@Path("id") id: Int): Call<User>

Parametry zapytania

Dodaj @Query dla wartości występujących po znaku zapytania, takich jak wyszukiwane hasła lub numery stron. Retrofit sam dopisze je do adresu URL.

@GET("search")
fun search(@Query("q") term: String): Call<Result>

Typ zwracany

Typ zwracany przez funkcję informuje Retrofit, jakiej struktury danych należy oczekiwać. Użyta tutaj data class jest bezpośrednio mapowana na odpowiedź JSON.

@GET("users/{id}")
fun getUser(@Path("id") id: Int): Call<User>

Ustaw bazowy adres URL

Tworzy się jedną instancję Retrofit z bazowym adresem URL. Każda zadeklarowana ścieżka endpointu jest automatycznie do niego dołączana.

val retrofit = Retrofit.Builder()
    .baseUrl("https://api.example.com/")
    .build()

Utwórz implementację

Wywołaj create z klasą interfejsu, a Retrofit zwróci gotowy do użycia obiekt. Nie trzeba samodzielnie pisać kodu żądań.

val api = retrofit.create(UserApi::class.java)

Dodaj fabrykę konwerterów

converter factory uczy Retrofit, jak zamieniać JSON na klasy danych. Dodaje się ją raz podczas tworzenia instancji.

.addConverterFactory(MoshiConverterFactory.create())

Nie zapomnij o uprawnieniu

Aby uzyskać dostęp do sieci, zadeklaruj uprawnienie INTERNET w manifeście. Bez niego każde żądanie zakończy się niepowodzeniem, zanim się rozpocznie.

<uses-permission android:name="android.permission.INTERNET" />

Szybkie sprawdzenie

Która adnotacja wstawia wartość bezpośrednio do ścieżki adresu URL?

Podsumowanie: interfejs API

Opisano endpointy jako annotated interface functions, ustawiono bazowy adres URL, dodano konwerter i zlecono Retrofitowi utworzenie klienta. Następnie przeanalizujesz zwracany przez niego kod JSON.

Bezpłatny start

Ucz się Kotlin dzięki korepetycjom AI — za darmo

Pisz i uruchamiaj kod w przeglądarce, otrzymuj natychmiastową pomoc od korepetytora AI dostępnego 24/7 i kontynuuj naukę w sieci lub w aplikacji.

Kursy
30
Lekcje
120

Często zadawane pytania

Czy lekcja „Definiowanie interfejsu API Retrofit” jest bezpłatna?

Tak — pełny tekst „Definiowanie interfejsu API Retrofit” jest dostępny za darmo tutaj w sieci. Aby ćwiczyć ją interaktywnie (wbudowany edytor kodu i tutor AI dostępny 24/7) i odblokować resztę kursu Jetpack Compose Academy, przejdź na CoddyKit PRO. Kurs Jetpack Compose Academy zawiera 4 lekcji w sumie.

Co nauczysz się w „Definiowanie interfejsu API Retrofit”?

Deklaruj endpointy za pomocą adnotacji Ćwiczysz Jetpack Compose Academy z praktycznym kodem, który uruchamiasz bezpośrednio w przeglądarce, a tutor AI dostępny 24/7 odpowiada na Twoje pytania podczas pracy nad lekcją.

Czy potrzebuję doświadczenia, aby zacząć Jetpack Compose Academy?

Nie wymagamy żadnego doświadczenia. Jetpack Compose Academy w CoddyKit jest strukturyzowany dla początkujących i zaawansowanych użytkowników, więc możesz zacząć tutaj lub od początku i uczyć się w swoim tempie. To lekcja 1 z 4.

Ile czasu zajmuje lekcja „Definiowanie interfejsu API Retrofit”?

Większość lekcji CoddyKit trwa około 5–10 minut. Każda lekcja to mały, interaktywny krok, dzięki czemu robisz systematyczne postępy i zawsze wracasz dokładnie do tego samego miejsca — na webie i w aplikacji.

Czy mogę pisać i uruchamiać kod w tej lekcji Jetpack Compose Academy?

Tak. Każda lekcja Jetpack Compose Academy zawiera wbudowany edytor kodu, więc piszesz i uruchamiasz prawdziwy kod bezpośrednio w przeglądarce i od razu otrzymujesz sprzężenie zwrotne od AI — bez konfiguracji na komputerze.

Wszystkie lekcje w tym kursie

  1. Definiowanie interfejsu API Retrofit
  2. Parsowanie JSON za pomocą Moshi
  3. Wywołania suspend w ViewModelu
  4. Interfejs wczytywania, powodzenia i błędu
← Powrót do Jetpack Compose Academy