Skip to content

HTTP API Patterns¶

Build robust HTTP APIs with HttpRequestData and HttpResponseData in .NET isolated worker.

flowchart TD
    A[Trigger] --> B[Function]
    B --> C[Binding or SDK]
    C --> D[Azure service]

Topic/Command Groups¶

Route templates and verbs¶

[Function("GetOrder")]
public async Task<HttpResponseData> GetOrder(
    [HttpTrigger(AuthorizationLevel.Function, "get", Route = "orders/{id}")] HttpRequestData req,
    string id)
{
    var response = req.CreateResponse(HttpStatusCode.OK);
    await response.WriteAsJsonAsync(new { id });
    return response;
}

Request body handling¶

using System.Text.Json;

var payload = await JsonSerializer.DeserializeAsync<CreateOrderRequest>(req.Body);

Response envelope pattern¶

var response = req.CreateResponse(HttpStatusCode.Created);
await response.WriteAsJsonAsync(new { orderId = "ord-1001", status = "created" });
return response;

Review Matrix¶

Review area	Page-specific check
Scope	Confirm the guidance applies to HTTP API Patterns.
Source basis	Validate the recommendation against the Microsoft Learn sources in this page.
Evidence	Capture command output, portal state, metrics, logs, or screenshots before treating the result as proven.

See Also¶

Sources¶