@postio/openapi

@postio/openapi

OpenAPI 3.1 specification for the Postio API — UK address, email, and phone number validation.

This package is the canonical machine-readable contract for everything above the API: typed clients, server SDKs, MCP tools, codegen, Postman collections, and AI agents reasoning about Postio.

Install

npm install @postio/openapi

Use

import spec from "@postio/openapi"
//   ^? OpenAPI 3.1 document (JSON)

import yamlSpec from "@postio/openapi/yaml"
//   ^? OpenAPI 3.1 document (YAML string)

Public URLs

If you don't want a package dependency, the same document is served publicly:

• https://postio.co.uk/openapi.json
• https://postio.co.uk/openapi.yaml

The version matches info.version in the spec.

Generated, not hand-written

The spec is generated from Zod schemas in postio-uk/postio-api via hono-openapi. Runtime validation and the published spec are guaranteed in sync — they share the same source.

License

MIT.