relax

Model and export ColdBox REST API documentation as JSON or XML using the Relax DSL.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill relax-coldbox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: relax
Source: https://github.com/ColdBox/skills/tree/main/modules/relax
Command: npx skills add https://github.com/ColdBox/skills --skill relax-coldbox

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provide a clear, maintainable way to describe ColdBox REST APIs using the Relax DSL so teams can generate consistent documentation and machine-readable specs without hand-editing JSON or XML outputs.

Core Features & Use Cases

  • Model-first API authoring: Define resources, verbs, route parameters, request bodies, and response schemas in a fluent Relax model.
  • Spec export and integration: Export API specifications as JSON or XML for Swagger UI, Postman, API gateways, or client generators.
  • Browsable documentation with safety: Render developer-facing API docs and restrict access in production environments to avoid accidental exposure.
  • Use Case: Model a /users resource with pagination, create/update schemas, and export a JSON spec for automated client generation.

Quick Start

Generate a JSON API specification from your MyAPIRelax model and render browsable documentation in a non-production environment.

Frequently Asked Questions about relax

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate browsable API documentation for a ColdBox REST service?

To generate browsable API documentation for ColdBox, define your resources and schemas using the Relax DSL, then render the model in a non-production environment to avoid accidental exposure.

Can I export a JSON or XML specification from a ColdBox API model?

Yes, you can export JSON or XML specifications from a ColdBox API model. The Relax DSL allows you to output machine-readable specs for integration with tools like Swagger UI, Postman, or API gateways.

What is the best way to model REST API resources without hand-editing JSON outputs?

The best way to model REST APIs without hand-editing JSON is using a model-first approach. The Relax DSL lets you fluently define resources, verbs, and route parameters to generate consistent specs automatically.

Does the Relax DSL support defining route parameters and response schemas for API docs?

Yes, the Relax DSL supports defining route parameters and response schemas. You can map request bodies and response structures directly within your ColdBox API model for accurate documentation rendering.

How do I restrict access to rendered API documentation in a production environment?

To restrict access to rendered API documentation in production, apply the non-production access safeguards built into the Relax DSL. This prevents accidental exposure of your developer-facing API docs.

Why use a model-first DSL for ColdBox API documentation instead of static files?

Using a model-first DSL for ColdBox API documentation provides a clear, maintainable way to describe REST APIs. It generates consistent documentation and machine-readable JSON or XML specs without manual file editing.