General structure for input parameters

[Rofl113]

I was thinking about how to pass additional general parameters without changing each function. Let's say: add a cancellation token or a unique user action number. It seems to me that adding such a description form will make it possible to do this easily.

Now:

@GET("/api/items/{itemId}")
Future<ItemInfo> getItemInfo({
	@Path("itemId") required final String id,
	@Queries() required final Params params
});

Suggestion:

class RequestParamsItem {
	const RequestParamsItem({ required this.id, required this.params });
	// Params
	@Path("itemId") final String id;
	@Queries() final Params params;
}

@GET("/api/items/{itemId}")
Future<ItemInfo> getItemInfo(
	@RequestParams() final RequestParamsItem params,
);

Then it would be possible to add a base class for common parameters.

class RequestParamsBase {
	RequestParamsBase({ this.cancelToken, this.idAction });
	// Params
	@CancelToken()
	CancelToken? cancelToken;
	@Header("X-ID-ACTION")
	String? idAction;
}

And inherit all requests from it.

class RequestParamsItem extends RequestParamsBase {
	const RequestParamsItem({ required this.id, required this.params });
	// Params
	@Path("itemId")
	final String id;
	@Queries()
	final Params params;
}