Water Restrictions API Docs

This project has since been deprecated and folded into the full Water Restrictions Website.

With the Water Restrictions API live, the goal was a documentation site where developers could explore its endpoints and concepts. Docusaurus was chosen for its markdown-based content authoring, with a Scalar integration providing an interactive API playground.

Documentation site

Home page of the Water Restrictions API docs — Home page

The docs covered how the API works and how it’s maintained, rather than low-level technical details. The Scalar API reference handled the technical specifics.

Introduction page of the Water Restrictions API docs — Introduction page

Scalar integration and API playground

Scalar generated the API reference on each page load by fetching the latest OpenAPI spec from the Water Restrictions API, keeping the reference in sync with the API automatically. Scalar inherited the site’s styling.

Introduction of the Water Restrictions API reference — Introduction to the API reference

Users could make live requests to real API endpoints directly from within the docs.

Testing a request in the Water Restrictions API docs — Testing a request

Stack

This project predates the current stack setup, so the setup differs slightly from newer projects.

Frontend: Docusaurus, Scalar (API playground integration)
Infrastructure: Terraform, GitHub Actions, Cloudflare Pages (hosting)