# apiaryio/api-blueprint

API Blueprint

Repository: https://github.com/apiaryio/api-blueprint
Canonical: https://ross.abutalabs.com/products/api-blueprint
Homepage: https://apiblueprint.org
License: MIT
License Family: permissive
Archived: true
Last push: 2023-08-19T19:11:28+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 4876, "days_push": 1110, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 8634, forks 2091 (observed 2026-08-28T04:10:23.935306+00:00)

## What it is
API Blueprint is a high-level markdown-based API description language for designing, documenting, mocking, and testing web APIs. This repository hosts the language specification, tutorials, and examples rather than a runnable tool.

## Use cases
- design and prototype a REST API before writing code
- generate API documentation from a plain-text blueprint
- create API mocks from a specification
- document an already deployed API
- collaborate with stakeholders on API design
- describe API data structures with MSON

## When to choose
- you prefer writing API specs in markdown with a concise syntax
- you want GitHub syntax highlighting for .apib files
- you use the Apiary/Dredd tooling ecosystem
- you need a human-readable API design language for team collaboration

## When to avoid
- your team standardizes on OpenAPI/Swagger with its larger ecosystem
- you need actively developed tooling and frequent spec updates
- you want machine-readable specs for automated codegen in modern pipelines

## Facets
- artifact type: learning-resource
- maturity: maintenance
- function: api-documentation, documentation, mock-api, markdown
- domain: apis, documentation, web-development, developer-tools
- platform: cross-platform, cli
- tags: api-blueprint, api-design, specification, mson, openapi-alternative, apib, web-server

## Member repositories
- apiaryio/api-blueprint (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:23.935306+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:25:51.111651+00:00, confidence not recorded.
  - readme: https://github.com/apiaryio/api-blueprint (fetched 2026-08-28T04:10:23.935306+00:00, sha 9c5141caee52)
  - homepage: https://apiblueprint.org (fetched 2026-08-29T08:26:32.878707+00:00, sha d69ae6520651)
  - site_page: https://apiblueprint.org/documentation (fetched 2026-08-29T08:26:32.887969+00:00, sha 2a3597e259d5)
  - site_page: https://apiblueprint.org/documentation/tutorial.html (fetched 2026-08-29T08:26:32.889903+00:00, sha 59508fdee23c)
- Data as of 2026-08-30T08:39:29.467469+00:00.