Postman-Go API Client SDK
A Go SDK for the Postman API.
This SDK follows the standard grokify SDK pipeline: an OpenAPI 3.0 specification
drives an internal client generated with ogen,
with hand-written, domain-oriented wrapper packages on top. Postman does not
publish a downloadable OpenAPI document, so the spec in openapi/openapi.yaml
is reconstructed and maintained in-repo by scripts/gen-openapi,
which parses Postman's official TypeScript SDK
(the authoritative machine-readable source, in the absence of a published spec)
and the public API reference.
Status
All 31 Postman API service areas (196 endpoints) have a hand-written Go wrapper
package with plain Go types, typed errors, and unit tests.
Each service is reachable from a single *postman.Client — see Usage.
On top of the service packages, ocsf maps Secret Scanner findings
to OCSF Detection Finding events for SIEMs and data
lakes — see Exporting to OCSF.
Documentation
The full guide site — installation, authentication, error handling, rate
limiting, OCSF export, testing, and a usage page per service — is published at
grokify.github.io/postman-go,
built with MkDocs + Material
from docs/ and mkdocs.yml. Preview it locally:
pip install mkdocs-material
mkdocs serve # http://127.0.0.1:8000
For the raw, endpoint-level API reference (not Go-specific usage), see
API Reference below. For GoDoc, see the badge at the top of
this file.
API Reference
docs/api-reference.html renders openapi/openapi.yaml
as a browsable API reference with Scalar.
It's a static page with no build step — open it directly:
open docs/api-reference.html # macOS; xdg-open on Linux
The page fetches the spec from main on GitHub, so it works whether you open
it locally, host it via GitHub Pages, or serve it from any static file server.
To preview local edits to openapi/openapi.yaml before pushing, run a local
server from the repo root (python3 -m http.server) and point the page's
url config at ../openapi/openapi.yaml instead.
Installation
go get github.com/grokify/postman-go
Requires Go 1.26 or later.
以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗
