raml-org/raml-specArchived

Features

• Declarative Modeling - Uses a human-readable YAML serialization format as the single source of truth for declarative API modeling.
• Contract-First API Frameworks - Provides a complete framework for defining API contracts that serve as the single source of truth for both server and client implementation.
• API Payload Types - Creates reusable scalar types, objects, arrays, and unions to validate API payloads.
• Reusable Data Schemas - Extracts data structures into named schemas to enable reuse and improve readability across the API definition.
• API Data Shapes - Defines the structural shape of API request and response payloads using object types and property requirements.
• Specification Overlays - Allows extending or modifying API specifications through a layering system without altering the original master files.
• Reusable Resource Definitions - Employs resource templates that specify common methods and properties to ensure consistency across endpoints.
• Interface Traits - Defines sets of common method properties, such as headers or query parameters, that can be applied to multiple resources.
• Resource Templates - Uses reusable templates for resources to specify common methods and properties, reducing definition redundancy.
• API Design Languages - Provides a declarative YAML-based language specifically for modeling RESTful interfaces and data structures.
• API Behavioral Traits - Applies reusable sets of methods and headers to multiple endpoints to ensure consistency across similar API resources.
• Resource Type Parameterization - Customizes shared resource types using placeholders, path parameters, and text transformers.
• Contract Extensions - Modifies or broadens existing API contracts through overlays to add behavior or metadata without changing the master file.
• API Governance Frameworks - Enforces consistent service architecture and contract compliance across teams using reusable traits and resource types.
• API Method Interactions - Declaratively models HTTP operations, including request bodies, headers, query parameters, and expected responses.
• API Resource Modeling - Organizes web endpoints into logical resources and defines their hierarchical relationships.
• Response Specifications - Maps HTTP status codes to expected outcomes with detailed descriptions and response data examples.
• Data Schema Validation - Enforces data types and required fields in request and response bodies through structured schema validation.
• API Specification Modularization - Provides mechanisms to organize complex API definitions by externalizing data types and traits into separate files.
• REST API Specifications - Implements an industry standard for organizing endpoints, parameters, and payloads into reusable structures.
• Specification Modularization - Organizes API definitions by externalizing types, traits, and security schemes into libraries or external files.
• HTTP Verb Lifecycle Mapping - Assigns standard HTTP verbs to resources to define permitted CRUD actions.
• Global API Metadata - Defines global API metadata such as title, base URI, and version for the entire service contract.
• Request Body Definitions - Specifies expected request body data using form parameters, binary streams, or structured schemas.
• REST API Specifications - Provides a standardized syntax for describing RESTful endpoints, data models, and resource interactions.
• RESTful Service Definitions - Defines RESTful services using resource-oriented architectures and standard HTTP verbs in a modular YAML format.
• API Documentation Generators - Includes human-readable titles, descriptions, and user guides formatted in Markdown within the specification.
• Specification Documentation Generators - Produces up-to-date technical documentation automatically by transforming formal syntax definitions into human-readable sites.
• Query Parameter Configurations - Configures optional and required query parameters to handle API filtering, pagination, and security tokens.
• API Contract Validation - Provides formal parsing and validation to ensure service implementations strictly adhere to the defined API contract.
• Hierarchical Resource Mappings - Structures API endpoints as a tree of nested paths and relative URIs to represent object collections.
• API Documentation Generators - Generates technical guides and reference material directly from a structured RAML specification.
• Template-Based Code Generators - Transforms declarative specification files into executable client SDKs, server boilerplate, and technical documentation.
• API Model Inheritance - Supports single and multiple inheritance to allow sub-types to specialize parent properties for resources and data types.
• API Authentication Schemes - Defines standard authentication mechanisms including Basic and OAuth to be applied globally or per resource.
• API Security Configurations - Provides declarative definitions for authentication and authorization schemes like OAuth within the API contract.
• URI Parameter Definitions - Defines dynamic path segments using curly bracket notation to target granular objects within URIs.
• API Simulation and Mocking - Creates functional mock servers from RAML definitions to enable frontend development and stakeholder review.
• Automated API Testing - Generates a suite of automated test cases directly from the API specification to validate implementation behavior.
• API Mocking Standards - Uses a formal specification to automate the generation of functional mock servers and technical documentation.
• Schema-Driven Mocking - Generates functional mock servers by interpreting defined data types and example values.
• API Client SDK Generators - Automates the generation of language-specific client SDKs directly from the API specification file.
• Resource Hierarchy Models - Builds a structured tree of absolute service paths using relative URIs and nested resources.
• General API Utilities - Specification for defining RESTful APIs.

Star history