nylo-networking

Nylo Networking

Overview

Nylo v7 networking is built on Dio and centered around NyApiService classes in lib/app/networking/. Services provide network() for typed responses and networkResponse() for full NyResponse<T> objects with status codes, headers, and error details.

When to Use

• Creating or modifying API service classes
• Making GET, POST, PUT, DELETE, PATCH requests
• Adding request/response interceptors
• Caching API responses with cache policies
• Handling authentication tokens and refresh logic
• Uploading or downloading files
• Configuring retry logic, timeouts, or connectivity checks
• When NOT to use: For local storage without network calls, use nylo-storage instead

Quick Reference

Action	Code
Create API service (CLI)	metro make:api_service user
Create with model	metro make:api_service user --model="User"
Create interceptor (CLI)	metro make:interceptor logging
Simple GET	await get<User>("/users/1")
Simple POST	await post<User>("/users", data: payload)
network() call	await network<User>(request: (r) => r.get("/users/1"))
networkResponse() call	await networkResponse<User>(request: (r) => r.get("/users/1"))
Use from page	await api<ApiService>((r) => r.fetchUser())
Cache response	network(..., cacheKey: "key", cacheDuration: Duration(hours: 1))
Bearer token	network(..., bearerToken: "token123")
Retry requests	network(..., retry: 3, retryDelay: Duration(seconds: 2))
Clear cache	await apiService.clearCache("key")

API Service Structure

Services live in lib/app/networking/ and extend NyApiService:

class ApiService extends NyApiService {
  ApiService({BuildContext? buildContext})
      : super(
          buildContext,
          decoders: modelDecoders,
        );

  @override
  String get baseUrl => getEnv('API_BASE_URL');

  @override
  Map<Type, Interceptor> get interceptors => {
    ...super.interceptors,
  };

  Future<User?> fetchUser(int id) async {
    return await network<User>(
      request: (request) => request.get("/users/$id"),
    );
  }

  Future<List<User>?> fetchUsers() async {
    return await network<List<User>>(
      request: (request) => request.get("/users"),
    );
  }

  Future<User?> createUser(Map<String, dynamic> data) async {
    return await network<User>(
      request: (request) => request.post("/users", data: data),
    );
  }
}