An API that cannot be described in the format the rest of the industry consumes is an API that has to be documented by hand and integrated by guesswork. The platform already generated a machine-readable description of every REST endpoint it exposes; this release emits that description as an OpenAPI specification, and rebuilds the explorer that sits on top of it.
OpenAPI out of the API definitions
- Generated, not maintained. An OpenAPI specification is produced from the REST API definitions themselves, so the contract a client generates from is the contract the server actually serves.
- Its own resource. The description functionality is separated into its own sub-resource, so the specification is fetched independently of the explorer that renders it.
- Downloadable. The specification is downloaded from the explorer, so it goes straight into a client generator or an API gateway.
An explorer built for a large surface
- One endpoint at a time. Endpoints move into a sidebar with a navigation model behind it, so a large API is traversed by search and selection instead of by scrolling one long page.
- Request beside the endpoint. The request sits next to the endpoint detail rather than below it, and the parameter form opens as a dialog, freeing the panel body for the response.
- Execution you can act on. Copy controls and a real error surface replace the previous silent failure, so a call that fails reports why.
- Dark appearance. The explorer supports the dark appearance, with the contrast problems it previously inherited corrected.
A lighter build
- Current toolchain. The explorer is rebuilt on Vue 3, Vuetify 4 and Vite.
- 19 icons instead of 7,462. The icon set ships only the icons the explorer uses, removing the bulk of a payload that was almost entirely unreferenced.
Existing REST endpoints are unchanged and require no annotation to appear in the specification; the explorer replaces the previous surface at the same address.