Skip to content

Using the Hub

The Grapity Hub is a developer portal for browsing, exploring, and comparing API specs registered with the Registry. It starts automatically when you run grapity serve.

Opening the Hub

bash
grapity serve
# => Hub ready at http://localhost:3000

Open http://localhost:3000 in your browser.

Browse all specs

The home page shows every spec in the Registry in a searchable list.

  • Search by name or description
  • Filter by type (OpenAPI / AsyncAPI), owner, or tags using the sidebar
  • Each card shows the spec name, type, latest version, and classification

Spec detail page

Click any spec to open its detail page. This page has five tabs:

Overview

The Overview tab renders the OpenAPI spec into an interactive endpoint explorer:

  • Endpoint list grouped by tag
  • Each endpoint shows its method, path, summary, and parameters
  • Click an endpoint to expand its request/response schemas
  • Schema properties are shown as a tree with types and descriptions

Compat

The Compat tab shows the compatibility report for the current version:

  • Classification (initial, major, minor, patch)
  • List of breaking changes with descriptions and affected paths
  • List of safe changes with descriptions
  • Previous version this was diffed against

Versions

The Versions tab shows a timeline of every version pushed:

  • Semver, classification, and push date
  • Pushed-by identity and git ref
  • Click any version to view its detail page

Compare

The Compare tab lets you select two versions side-by-side and see their compatibility reports next to each other. Useful for evaluating whether to upgrade a dependency.

Raw Spec

The Raw Spec tab shows the original OpenAPI or AsyncAPI document as formatted JSON or YAML. Copy it or download it for use with external tools (Swagger UI, Redoc, Postman, etc.).

Direct spec URLs

You can fetch any spec directly via the Registry API without opening the Hub:

bash
curl http://localhost:3750/v1/specs/payments-api/spec.yaml

Or a specific version:

bash
curl http://localhost:3750/v1/specs/payments-api/versions/1.2.0/spec.json

These URLs return the correct Content-Type header for OpenAPI or AsyncAPI specs.

Dark mode

The Hub respects your system preference for dark or light mode. Toggle it in your OS settings.

See also

Released under the Apache 2.0 License.