Skip to content
@api-commons

API Commons

This is the working group for API Commons

API Commons

Open, machine-readable API operations — a set of browser-first tools and machine-readable building blocks, openly governed under apicommons.org. Everything here speaks APIs.json and plugs into the wider APIs.io network.

Tools

Browser-first, backend-free tools for discovering, documenting, validating, governing, and reporting on the APIs you produce and consume. Most run entirely in your browser — your tokens and data never leave it.

Tool What it does Try it
api-discovery A browser-first registry for API artifacts. Search APIs.io and code across GitHub/GitLab/Bitbucket, keep provenance, save locally, and commit or PR back with your own token. Roll it all into a single APIs.json 0.21 index. discovery.apicommons.org
api-documentation Standalone documentation for any APIs.json — rich HTML docs for every API, property, and inline artifact, with OpenAPI as a full reference and Arazzo as step-by-step timelines. documentation.apicommons.org
api-validator A governance validator for OpenAPI (3.x and Swagger 2.0), AsyncAPI, Arazzo, and JSON Schema, powered by Spectral. Search Git hosts for real artifacts, lint against a best-of-breed ruleset, edit rules, and commit or PR back. validator.apicommons.org
api-reusability Assess how reusable the APIs across your organization really are — discover, index as APIs.json, then score reusability and duplication rolled up by org, team, or domain. reusability.apicommons.org
mcp-install The universal install button for MCP servers — one button, every client. One-click deep links, ready-to-run CLI commands, and per-OS config snippets, driven by an open registry of client install methods. install.apicommons.org
api-governance-mcp The AI surface of the validator — a Model Context Protocol server that lets any AI client lint OpenAPI, AsyncAPI, Arazzo, JSON Schema, APIs.json, MCP, and more, conversationally. npx @api-common/api-governance-mcp
spectral-reporter Turn a Spectral lint run into a beautiful, self-contained HTML governance report — the newman-reporter-htmlextra for API governance. SARIF output and trend reports over time. reporter.apicommons.org
governance-pipeline-auditor Lint your linting. Scan a repo's Spectral CI setup and score it against an 8-point governance maturity rubric, then get a prioritized punch-list of fixes. CLI, GitHub Action, and browser. auditor.apicommons.org
spectral-ruleset-studio Turn a prose style guide into an owned, grounded, well-named Spectral ruleset — for OpenAPI 3.x, Swagger 2.0, or both. Twenty grounded starter templates included. studio.apicommons.org
ruleset-commons A registry of adoptable, provenanced governance rulesets — adopt a real owned ruleset by reference instead of running the linter's defaults. National, industry, security, and company rulesets. rulesets.apicommons.org
governance-pipeline A reference API governance pipeline you can fork — PR-gated, path-filtered, SHA-pinned, a dedicated OWASP security job, and a human-readable report. A composite GitHub Action. pipeline.apicommons.org
spectral-owasp-ruleset A grounded Spectral ruleset for the OWASP API Security Top 10 — add a real security governance layer in one line. npm i -D @api-common/spectral-owasp-ruleset

The governance tools (validator, governance-mcp, reporter, auditor, ruleset studio, ruleset commons, governance pipeline, and the OWASP ruleset) grew out of a field study of 1,005 real-world CI pipelines — see The State of Spectral in API Pipelines for the research behind them.

Building blocks

Machine-readable API building blocks — small, focused schemas that describe one facet of running an API program, meant to be composed together and referenced from an APIs.json index.

Block What it describes
guidance The how-to layer that turns governance rules into help.
policies The business rules behind API governance.
rules Spectral rulesets across many artifact types.
lifecycle The stages every API moves through.
experiences The developer experiences an API program offers.
teams The people layer of API operations.
vocabulary Shared words and definitions for API operations.
use-cases Named use cases an API serves.
plans Machine-readable API access plans, tiers, and pricing.
change-log A machine-readable way to publish an API's changelog.
road-map A machine-readable way to publish an API's roadmap.
json-api Schemas and governance for the JSON:API standard.
interface-license Apply an open license to your API's interface — its surface, not its implementation.

Standards, templates & examples

Repo What it is
api-onboarding The API Onboarding Descriptor (AID) — a machine-readable /.well-known/api-onboarding document describing what it takes to onboard with an API: account, plan gates, ToS, verification, registration, and an executable flow.
problem-details-for-http-apis A base for using RFC 9457 Problem Details for HTTP APIs in your own API.
agent-skills Reference agent skills (SKILL.md) for the API Commons / APIs.io ecosystem.
train-travel An OpenAPI + APIs.json template for a Train Travel API — handy for demos and testing.
examples Shared examples for the API Commons building blocks and the APIs.json ecosystem.
snacks-twilio-messages An API Snack for AI — send a message with Twilio, described as a minimal, composable capability.

The hub

api-commons is the source for apicommons.org itself — the building blocks, the tool family above, and the wider index.

Get involved

Each repo above releases independently. Shared contribution conventions — branch/PR/merge, the common script contract, and our security policy — live in CONTRIBUTING.md and SECURITY.md. Everything here is open source and free to fork — Apache-2.0 throughout, except the api-commons hub content, which is CC BY 3.0. API Evangelist offers expert services when you want help.

Popular repositories Loading

  1. api-commons api-commons Public

    The API Commons — the hub and website (apicommons.org) for open, machine-readable API building blocks, standards, and browser-first tools.

    HTML 10 1

  2. json-api json-api Public

    JSON:API artifacts for the API Commons — schemas and governance for the JSON:API standard.

    2

  3. train-travel train-travel Public

    This is the repository for managing the APIs.json for the Train Travel API template.

    1

  4. change-log change-log Public

    The change log schema for the API Commons — a machine-readable way to publish an API's changelog.

    1

  5. vocabulary vocabulary Public

    Machine-readable API vocabulary building blocks for the API Commons — shared words and definitions for API operations.

    1

  6. plans plans Public

    The plans schema for the API Commons — machine-readable API access plans, tiers, and pricing.

    1

Repositories

Showing 10 of 34 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…