OverviewHistoryStatsSecurity
npx skills add ...
Documentation
SKILL.md
npx skills add new-silvermoon/awesome-android-agent-skills --skill android-retrofit
Expert guidance on setting up and using Retrofit for type-safe HTTP networking in Android. Covers service definitions, coroutines, OkHttp configuration, and Hilt integration.
npx skills add new-silvermoon/awesome-android-agent-skills --skill android-retrofit
When implementing network layers using Retrofit, follow these modern Android best practices (2025).
Retrofit allows dynamic URL updates through replacement blocks and query parameters.
{name} in the relative URL and @Path("name") in parameters.@Query("key") for individual parameters.@QueryMap Map<String, String> for dynamic sets of parameters.You can send objects as JSON bodies or use form-encoded/multipart formats.
application/x-www-form-urlencoded. Use @Field.multipart/form-data. Use @Part.Headers can be set statically for a method or dynamically via parameters.
@Headers.@Header.@HeaderMap.When using suspend functions, you have two choices for return types:
User): Returns the deserialized body. Throws HttpException for non-2xx responses.Response<User>: Provides access to the status code, headers, and error body. Does NOT throw on non-2xx results.Provide your Retrofit instances as singletons in a Hilt module.
Always handle network exceptions in the Repository layer to keep the UI state clean.
suspend functions for all network calls.Response<T> if you need to handle specific status codes (e.g., 401 Unauthorized).@Path and @Query instead of manual string concatenation for URLs.OkHttpClient with logging (for debug) and sensible timeouts.interface UserService {
@POST("users/new")
suspend fun createUser(@Body user: User): User
@FormUrlEncoded
@POST("user/edit")
suspend fun updateUser(
@Field("first_name") first: String,
@Field("last_name") last: String
): User
@Multipart
@PUT("user/photo")
suspend fun uploadPhoto(
@Part("description") description: RequestBody,
@Part photo: MultipartBody.Part
): User
}interface WidgetService {
@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
suspend fun widgetList(): List<Widget>
@GET("user")
suspend fun getUser(@Header("Authorization") token: String): User
}@GET("users")
suspend fun getUsers(): List<User> // Throws on error
@GET("users")
suspend fun getUsersResponse(): Response<List<User>> // Manual check@Module
@InstallIn(SingletonComponent::class)
object NetworkModule {
@Provides
@Singleton
fun provideJson(): Json = Json {
ignoreUnknownKeys = true
coerceInputValues = true
}
@Provides
@Singleton
fun provideOkHttpClient(): OkHttpClient = OkHttpClient.Builder()
.addInterceptor(HttpLoggingInterceptor().apply { level = HttpLoggingInterceptor.Level.BODY })
.connectTimeout(30, TimeUnit.SECONDS)
.build()
@Provides
@Singleton
fun provideRetrofit(okHttpClient: OkHttpClient, json: Json): Retrofit = Retrofit.Builder()
.baseUrl("https://api.github.com/")
.client(okHttpClient)
.addConverterFactory(json.asConverterFactory("application/json".toMediaType()))
.build()
}class GitHubRepository @Inject constructor(private val service: GitHubService) {
suspend fun getRepos(username: String): Result<List<Repo>> = runCatching {
// Direct body call throws HttpException on 4xx/5xx
service.listRepos(username)
}.onFailure { exception ->
// Handle specific exceptions like UnknownHostException or SocketTimeoutException
}
}