weatherapi/README.md

weatherapi

weatherapi is a read-only HTTP API for weather data already stored by weatherfeeder in PostgreSQL. It exposes the latest observations, current conditions, alerts, forecasts, discussions, and weather stories as JSON, XML, or text.

Quickstart

The service needs a reachable Postgres database with weatherfeeder-owned tables and the configured text template directory.

go run ./cmd/weatherapi -config config.yml

The checked-in config.yml is a local sample. For new deployments, start from examples/config.minimal.yml or examples/config.production.yml and provide database credentials through your normal secret-management process.

Endpoint Families

• Observations and current conditions
• Active alerts
• Hourly and narrative forecasts
• Forecast discussions
• Weather stories

See docs/api.md for the HTTP contract.

Documentation

• docs/api.md: public HTTP API reference
• docs/cli.md: command-line usage
• docs/config.md: YAML configuration reference
• docs/policy/architecture.md: development architecture and invariants