Quick Start
Get up and running with Thymian in minutes. Follow our step-by-step guide to add resilience and HTTP conformance to your APIs.
Get StartedFrom specification to production — see where Thymian lints, tests, and analyzes your APIs.
Thymian fits naturally into the development loop — whether you're coding by hand or an AI agent is driving. Generate, validate, fix, repeat.
Write or generate an OpenAPI spec or API implementation based on requirements.
Lint specs, test live endpoints, or analyze traffic — same rules, every context.
Rich error context with rule IDs, RFC references, and exact locations enables targeted fixes.
Designed from the ground up for both human developers and AI agents.
Violations include rule names, RFC references, severity levels, and exact locations — giving any AI agent or developer all the context needed to fix issues.
Non-interactive mode with explicit flags ensures reproducible results — perfect for agentic retry-and-fix workflows.
Exit codes, structured results, and typed schemas mean agents never have to parse prose or guess what went wrong.
Generate configs, rules, and sample data programmatically with --no-interactive — no human prompts blocking the pipeline.
Language-agnostic CLI output works with GitHub Copilot, Cursor, Aider, local models, or any tool that reads structured output.
Lint, test, analyze — each command does one thing well and plays nicely with pipes and automation scripts.
Write validation logic once — Thymian applies it across your entire API lifecycle, catching inconsistencies before they reach users.
export default httpRule('consistent-error-responses')
.severity('error')
.type('static', 'test', 'analytics')
.description('Error responses must use problem+json')
.rule(ctx =>
ctx.validateCommonHttpTransactions(
statusCodeRange(400, 599),
not(responseMediaType('application/problem+json'))
)
)
.done(); Validates API specifications before any code is written.
Actively tests running endpoints against the same rule.
Analyzes real traffic to verify compliance passively.
Package rules as npm modules and share them across teams and projects.
Use built-in sets like @thymian/rules-rfc-9110 or create your
own organizational standards.
@thymian/rules-rfc-9110 @thymian/rules-api-description-validation @your-org/api-standards Virtually everything in Thymian is a plugin. A reactive event bus connects them all — swap, extend, or build your own without touching a single line of framework code or even JavaScript!
Core features, integrations, and extensions are all plugins — the framework imposes no hard-coded behavior.
Plugins communicate through a reactive event bus with typed events, actions, and error flows.
Plugins interact through well-defined APIs and events. Add, remove, or swap plugins without touching others.
Connect plugins running in any language or process over WebSockets — perfect for polyglot environments.
Publish plugins and rule sets as npm modules. Share validation logic across teams and projects.
Plugin options are validated at startup via JSON Schema — catch misconfigurations before they cause failures.
import type { ThymianPlugin } from '@thymian/core';
export const myPlugin: ThymianPlugin = {
name: 'my-custom-plugin',
version: '*',
async plugin(bus, logger, options) {
bus.onAction('core.ready', async (payload, ctx) => {
logger.info('Plugin is ready!');
ctx.reply();
});
bus.onAction('core.lint', async (payload, ctx) => {
// Your custom validation logic here
ctx.reply({ results: [] });
});
}
};
Ready-to-use plugins covering every stage of the API lifecycle — or build your own with the same powerful APIs.
Static analysis of OpenAPI specs and HTTP definitions.
Live endpoint testing against your rule definitions.
Passive analysis of recorded HTTP traffic for compliance.
Load, parse, and validate OpenAPI specifications.
Collect and format validation results into reports.
File-based HTTP request sampling for reproducible tests.
Connect remote plugins over WebSocket for distributed setups.
Dispatch HTTP requests to live endpoints for testing.
Implement the ThymianPlugin interface, hook into lifecycle
events, and publish as an npm package. Local plugins, remote WebSocket
plugins, and shared rule sets all use the same unified API.
Quick Start
Get up and running with Thymian in minutes. Follow our step-by-step guide to add resilience and HTTP conformance to your APIs.
Get StartedThymian CLI
Master the Thymian command-line interface. Learn how to use powerful CLI commands to test, analyze, and validate your APIs from the terminal.
View CLI DocsPlugin Ecosystem
Explore plugins to extend Thymian’s capabilities. Discover plugins that add new features and integrations to your workflow.
Explore PluginsIntegrations
Install Thymian integrations to extend your workflow. Explore integrations that automate your testing, monitoring, and deployment processes.
Explore IntegrationsDocumentation
Comprehensive guides and API reference. Dive deep into Thymian’s features, configuration options, and best practices.
Read DocsEnterprise Support
Professional consulting and dedicated support from the creators of Thymian for your team. Get expert help with implementation, custom solutions, and priority support.
Learn More