Rewrite public API documentation

This commit is contained in:
2026-06-11 14:13:46 +00:00
parent b4bdd2e4f1
commit a0f5e85516
2 changed files with 370 additions and 411 deletions

45
examples/requests.http Normal file
View File

@@ -0,0 +1,45 @@
@baseUrl = http://localhost:8080
### Latest observation
GET {{baseUrl}}/observations?units=metric&precision=1
Accept: application/json
### Current conditions
GET {{baseUrl}}/conditions/current?units=us&precision=0
Accept: application/json
### Active alerts as text
GET {{baseUrl}}/alerts/active?format=text
### Hourly forecast in US units
GET {{baseUrl}}/forecast/hourly?units=us&precision=1&tz=Chicago
Accept: application/json
### Hourly forecast for today
GET {{baseUrl}}/forecast/hourly/today?tz=CDT
Accept: application/json
### Narrative forecast for tomorrow as text
GET {{baseUrl}}/forecast/narrative/tomorrow?format=text&tz=America/Chicago
### Full forecast discussion
GET {{baseUrl}}/discussion?tz=CDT
Accept: application/json
### Forecast discussion key messages as text
GET {{baseUrl}}/discussion/key-messages?format=text
### Forecast discussion short term
GET {{baseUrl}}/discussion/short-term?tz=CDT
Accept: application/json
### Forecast discussion long term
GET {{baseUrl}}/discussion/long-term?TZ=-5
Accept: application/json
### Weather stories
GET {{baseUrl}}/weatherstories?tz=America/Chicago
Accept: application/json
### Latest weather story as XML
GET {{baseUrl}}/weatherstories/latest?format=xml