GunSpec
Tooling

Tools & spec

Generate clients, explore endpoints, and import the API into your favourite tools.

OpenAPI spec

The full API is described by an OpenAPI 3 document at /openapi.json, served without authentication.

bash
curl https://api.gunspec.io/openapi.json

Feed it to a generator like openapi-generator or orval to produce a typed client in any language.

Open spec

Interactive explorer

A live Swagger UI is hosted at /docs for trying endpoints in the browser. Add your API key in the Authorize dialog.

Open explorer

Postman & Insomnia

Import the OpenAPI document to get a ready-made request collection.

  1. In Postman, choose Import.
  2. Pick Link and paste https://api.gunspec.io/openapi.json.
  3. Add your key as an X-API-Key header on the collection.
PostmanInsomnia

Official SDKs

Prefer a typed client? Install the maintained TypeScript or Python SDK.

TypeScript / Node 0.10.0
bash
npm install @buun_group/gunspec-sdk
Python 0.5.0
bash
pip install gunspec
@buun_group/gunspec-sdkgunspec