Special Parameters

Special parameters refer to certain parameter types that can work without any attributes.

CancellationToken Type

Each interface supports declaring one or more parameters of type CancellationToken for canceling request operations.

public interface IUserApi
{
    [HttpGet("api/users/{id}")]
    Task<User> GetAsync(string id, CancellationToken token = default); 
}

FileInfo Type

Used as a file item in a multipart/form-data form to implement file upload functionality.

public interface IUserApi
{
    [HttpPost("api/users")] 
    Task<User> PostAsync([FormDataContent] User user, FileInfo headImage);
}

Subtypes of HttpContent

public interface IUserApi
{
    [HttpPost("api/users/{id}")]
    Task PostAsync(StringContent text);

    [HttpPost("api/users/{id}")]
    Task PostAsync(StreamContent stream);

    [HttpPost("api/users/{id}")]
    Task PostAsync(ByteArrayContent bytes);
}

Subtypes of IApiParameter

Types that implement IApiParameter are called self-explanatory parameter types, which can address some complex parameters that attributes cannot solve.

FormDataFile Type

Used as a file item in a multipart/form-data form to implement file upload functionality, equivalent to the FileInfo type.

public interface IUserApi
{
    [HttpPost("api/users")] 
    Task<User> PostAsync([FormDataContent] User user, FormDataFile headImage);
}

JsonPatchDocument Type

Represents a JsonPatch request document.

public interface IUserApi
{
    [HttpPatch("api/users/{id}")]
    Task<UserInfo> PatchAsync(string id, JsonPatchDocument<User> doc);
}

var doc = new JsonPatchDocument<User>();
doc.Replace(item => item.Account, "laojiu");
doc.Replace(item => item.Email, "laojiu@qq.com");