# raml-org/raml-spec

RAML Specification

Repository: https://github.com/raml-org/raml-spec
Canonical: https://ross.abutalabs.com/products/raml-spec
Homepage: http://raml.org
License Family: other
Topics: raml, api-documentation, api-definition, raml-specification
Archived: true
Last push: 2022-03-25T21:55:39+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": 4720, "days_push": 1622, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: archived, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3847, forks 843 (observed 2026-08-28T04:08:24.185980+00:00)

## What it is
The official specification for RAML (RESTful API Modeling Language), a YAML-based language for describing practically-RESTful HTTP APIs in a human- and machine-readable format. This repository hosts the RAML 1.0 spec document, which defines how to model resources, methods, parameters, types, and responses to enable code generation, mocking, testing, and documentation.

## Use cases
- define a REST API contract in a readable YAML format
- generate API documentation from a spec
- generate client and server code stubs from an API definition
- mock an API before implementation
- learn how to write RAML 1.0 API definitions
- model reusable types and schemas for an API

## When to choose
- you want a human-readable, YAML-based alternative to OpenAPI for designing REST APIs
- you follow a design-first workflow and need a formal versioned API contract
- you need to generate docs, mocks, or code from a single API definition

## When to avoid
- you need a spec with broad current tooling adoption and active ecosystem momentum (OpenAPI is more widely supported)
- you need a runnable library or tool rather than a specification document
- you are building non-REST or event-driven APIs

## Facets
- artifact type: learning-resource
- maturity: maintenance
- function: api-documentation, documentation, serialization
- domain: apis, web-development, documentation, developer-tools
- platform: cross-platform
- tags: raml, api-specification, rest, yaml, api-design, specification, contract-first

## Member repositories
- raml-org/raml-spec (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:24.185980+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-29T18:26:00.573772+00:00, confidence not recorded.
  - readme: https://github.com/raml-org/raml-spec (fetched 2026-08-28T04:08:24.185980+00:00, sha 380a3a7d1df7)
  - homepage: http://raml.org (fetched 2026-08-29T09:21:11.700049+00:00, sha cbc0a42e03ab)
  - site_page: https://raml.org/about-raml (fetched 2026-08-29T09:21:11.709457+00:00, sha 21df721e2f26)
- Data as of 2026-08-30T08:39:29.467469+00:00.