Skip to content

README.md

Latest commit

 

History

History
65 lines (46 loc) · 2.41 KB

README.md

File metadata and controls

65 lines (46 loc) · 2.41 KB

Grapity — API contract governance

Open-source API governance. Ship APIs that won't break your consumers.

CI npm License: Apache 2.0 Docs

grapity.dev · Quickstart · CLI Reference · @grapitydev

Grapity is a contract registry that validates backward compatibility, auto-assigns semver, provisions Kong gateways from the same spec, and serves a browsable Hub for every API your team ships.

Installation

npm install -g @grapity/grapity

Quick start

Local mode

Run a registry server on this machine. No external dependencies.

grapity init --local
grapity serve --no-auth

Open http://localhost:3000 for the Hub and use http://localhost:3750 for the Registry API.

Remote mode

Connect to a hosted Grapity instance. No server to run.

grapity init --remote --url https://api.grapity.dev

Things you can do

  • Publish specs — grapity registry push validates backward compatibility and assigns semver.
  • Pull specs into repos — grapity materialize pins versions in grapity.yaml and grapity-lock.json.
  • Provision gateways — grapity gateway provision generates decK YAML and applies it to Kong.
  • Browse APIs — grapity serve starts the Hub for exploring specs and comparing versions.

See the CLI Reference and Platform docs for full details.

License

Apache-2.0