forecasts.aug

Weather API · Source and specification

Files in this project

• main.aug
• forecasts.aug

Code

Indentation

// aug-spec: "forecasts.aug.md" explains this file. Read it before changes; refresh with aug spec.
/** The JSON shape returned by the forecast endpoint. Temperatures use whole degrees. */
Explanation 1Explanation 2
record WeatherForecast(string date, int temperatureC, int temperatureF, string summary)
/** Return five simulated forecasts. Fixed data keeps the example and its tests reproducible. */
Explanation 1Explanation 2Explanation 3
endpoint GET "/weatherforecast" as weatherForecast():
    return [
        WeatherForecast(
            date="2026-01-01",
            temperatureC=0,
            temperatureF=32,
            summary="Freezing"
        ),
        WeatherForecast(
            date="2026-01-02",
            temperatureC=10,
            temperatureF=50,
            summary="Cool"
        ),
        WeatherForecast(
            date="2026-01-03",
            temperatureC=20,
            temperatureF=68,
            summary="Mild"
        ),
        WeatherForecast(
            date="2026-01-04",
            temperatureC=30,
            temperatureF=86,
            summary="Warm"
        ),
        WeatherForecast(
            date="2026-01-05",
            temperatureC=35,
            temperatureF=95,
            summary="Hot"
        )
    ]
test endpoint weatherForecast client:
    when "forecasts":
        it "returns_json":
            response = client.request(method="GET", path="/weatherforecast")
            assert(condition=response.status == 200)
        it "rejects_other_methods":
            response = client.request(method="POST", path="/weatherforecast")
            assert(condition=response.status == 405)

Braces

// aug-spec: "forecasts.aug.md" explains this file. Read it before changes; refresh with aug spec.
/** The JSON shape returned by the forecast endpoint. Temperatures use whole degrees. */
Explanation 1Explanation 2
record WeatherForecast(string date, int temperatureC, int temperatureF, string summary)
/** Return five simulated forecasts. Fixed data keeps the example and its tests reproducible. */
Explanation 1Explanation 2Explanation 3
endpoint GET "/weatherforecast" as weatherForecast() {
    return [
        WeatherForecast(
            date="2026-01-01",
            temperatureC=0,
            temperatureF=32,
            summary="Freezing"
        ),
        WeatherForecast(
            date="2026-01-02",
            temperatureC=10,
            temperatureF=50,
            summary="Cool"
        ),
        WeatherForecast(
            date="2026-01-03",
            temperatureC=20,
            temperatureF=68,
            summary="Mild"
        ),
        WeatherForecast(
            date="2026-01-04",
            temperatureC=30,
            temperatureF=86,
            summary="Warm"
        ),
        WeatherForecast(
            date="2026-01-05",
            temperatureC=35,
            temperatureF=95,
            summary="Hot"
        )
    ]
}
test endpoint weatherForecast client {
    when "forecasts" {
        it "returns_json" {
            response = client.request(method="GET", path="/weatherforecast")
            assert(condition=response.status == 200)
        }
        it "rejects_other_methods" {
            response = client.request(method="POST", path="/weatherforecast")
            assert(condition=response.status == 405)
        }
    }
}

Compiled specification

Interactions and sequences

Plain handler results default to HTTP 200 unless another status is declared. HttpResponse values choose their own status. Unhandled request failures return HTTP 500 and cancel the request tasks.

WeatherForecast · immutable record · source

The JSON shape returned by the forecast endpoint. Temperatures use whole degrees. It takes date as a string, kept read-only, temperatureC and temperatureF as integers, kept read-only, and summary as a string, kept read-only.

weatherForecast · source

weatherForecast handles GET /weatherforecast. Return five simulated forecasts. Fixed data keeps the example and its tests reproducible. It returns a list of 5 WeatherForecast records, with (date, temperatureC, temperatureF, summary) values of ("2026-01-01", 0, 32, "Freezing"), ("2026-01-02", 10, 50, "Cool"), ("2026-01-03", 20, 68, "Mild"), ("2026-01-04", 30, 86, "Warm"), and ("2026-01-05", 35, 95, "Hot"), in that order. source

Checked interface

weatherForecast() returns List<WeatherForecast>

test weatherForecast client · source

Tests weatherForecast. Each case gets fresh setup and dependencies.

forecasts

returns_json · source

It sets response to client.request with method "GET" and path "/weatherforecast". The test requires response.status equals 200. source

rejects_other_methods · source

It sets response to client.request with method "POST" and path "/weatherforecast". The test requires response.status equals 405. source

Built-in operations follow the language reference.