Definindo uma Interface de API Retrofit
Declare endpoints com anotações.
Definindo uma Interface de API Retrofit é uma aula grátis de Jetpack Compose Academy no CoddyKit. Esta é a aula 1 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Jetpack Compose Academy, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Jetpack Compose Academy inclui 4 aulas no total.
Partes desta aula ainda não foram traduzidas e aparecem em inglês.
What Retrofit Does
Retrofit turns a plain Kotlin interface into a working HTTP client, so you describe your API and it writes the networking code for you.
It Starts With an Interface
You declare each endpoint as a function inside a Kotlin interface. Retrofit reads the annotations and builds the real implementation at runtime.
interface UserApi {
// endpoint functions go here
}Mark a GET Request
The @GET annotation tells Retrofit this function fetches data. You pass the path that sits after your base URL. 🌐
@GET("users")
fun getUsers(): Call<List<User>>POST, PUT and DELETE Too
Beyond GET, Retrofit offers @POST, @PUT, and @DELETE so one interface can read and write data on your server.
@POST("users")
fun createUser(@Body user: User): Call<User>Path Parameters
Use @Path to inject a value into the URL. Retrofit swaps the named placeholder in braces for the argument you pass in.
@GET("users/{id}")
fun getUser(@Path("id") id: Int): Call<User>Query Parameters
Add @Query for values after the question mark, like search terms or page numbers. Retrofit appends them to the URL for you.
@GET("search")
fun search(@Query("q") term: String): Call<Result>The Return Type
The function's return type tells Retrofit what shape to expect back. A data class here maps straight onto the JSON response.
@GET("users/{id}")
fun getUser(@Path("id") id: Int): Call<User>Set the Base URL
You build one Retrofit instance with the base URL. Every endpoint path you declared is joined onto it automatically.
val retrofit = Retrofit.Builder()
.baseUrl("https://api.example.com/")
.build()Create the Implementation
Call create with your interface class and Retrofit returns a ready-to-use object. You never write the request code yourself.
val api = retrofit.create(UserApi::class.java)Add a Converter Factory
A converter factory teaches Retrofit how to turn JSON into your data classes. You add it once when building the instance.
.addConverterFactory(MoshiConverterFactory.create())Don't Forget the Permission
To reach the network, declare the INTERNET permission in your manifest. Without it, every request fails before it even starts.
<uses-permission android:name="android.permission.INTERNET" />Quick Check
Which annotation injects a value directly into the URL path?
Recap: Your API Interface
You described endpoints as annotated interface functions, set a base URL, added a converter, and let Retrofit build the client. Next you'll parse the JSON it returns.
Perguntas Frequentes
A aula “Definindo uma Interface de API Retrofit” é grátis?
Sim — o texto completo de “Definindo uma Interface de API Retrofit” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Jetpack Compose Academy, atualize para CoddyKit PRO. O curso de Jetpack Compose Academy inclui 4 aulas no total.
O que vou aprender em “Definindo uma Interface de API Retrofit”?
Declare endpoints com anotações. Você pratica Jetpack Compose Academy com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.
Preciso ter experiência prévia para começar Jetpack Compose Academy?
Nenhuma experiência prévia é necessária. Jetpack Compose Academy no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 1 de 4.
Quanto tempo leva a aula “Definindo uma Interface de API Retrofit”?
A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.
Posso escrever e executar código nesta aula de Jetpack Compose Academy?
Sim. Cada aula de Jetpack Compose Academy inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.
Todas as aulas deste curso
- Definindo uma Interface de API Retrofit
- Analisando JSON com Moshi
- Chamadas suspend no ViewModel
- Interface de Carregamento, Sucesso e Erro