raml-org/raml-spec resource

Health v2 · maintenance only

Flags: archived no_license

Adoption not part of the score

3847 stars · 843 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded

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

learning-resource · maturity maintenance

api-documentation documentation serialization apis web-development documentation developer-tools cross-platform raml api-specification rest yaml api-design specification contract-first

Member repositories

For agents

markdown · JSON · MCP: product_card(name="raml-org/raml-spec")