thymian
v0.1.9
Published
AI-ready API governance engine - lint, test & analyze HTTP conformance across your entire API lifecycle
Readme
Thymian
Add resilience and HTTP conformance to your API development workflow
Thymian is a language-agnostic, open-source HTTP conformance and API governance tool. It validates your APIs against RFC standards and your OpenAPI specification out of the box, statically, against live endpoints, and in recorded production traffic. Fully extensible with plugins and shareable custom rules that you write once and run everywhere.
Key Capabilities
- Standards-First — Validates against RFC 9110 and related HTTP specifications
- Write Once, Validate Everywhere — A single rule definition works across
thymian lint,thymian test, andthymian analyze - Multi-Layer Governance — Validates HTTP infrastructure, protocol compliance, technical implementation, and organizational guidelines
- Educational Reporting — Violations explain the RFC semantics and real-world consequences, not just pass/fail
- Production-Aware — Monitors how proxies, CDNs, and load balancers affect HTTP semantics in real deployments
- Language-Agnostic & Extensible — Works with any tech stack; custom rules distributable as npm packages, remote plugins via WebSocket
🚀 Quick Installation
Installation
You won't need to install Thymian locally, we will just use npx for this.
Check if you can run Thymian by running the following command:
npx thymian --versionFirst Run Without a Config
Now navigate to your project's root directory and run Thymian directly against your API description:
npx thymian lint --spec openapi:openapi.yamlThis is the fastest way to reach a first conformance result without any prior setup.
Generate a Reusable Config
If you want to save that setup for future runs, generate a config file:
npx thymian generate configThis command detects your OpenAPI specification file and creates a thymian.config.yaml you can reuse with npx thymian lint.
📚 Documentation
- Getting Started - Set up Thymian in minutes
- Documentation - Comprehensive guides and API reference
- CLI Reference - Complete CLI command documentation
- HTTP Rules - Learn about HTTP conformance validation
🏢 Enterprise Support
Get professional consulting and dedicated support from the creators of Thymian. We offer:
- API design and governance strategies
- HTTP standards compliance auditing
- Custom plugin development
- Custom rule development
- Team training and workshops
Learn more about Enterprise Support | Email: [email protected]
Shipped with 🌱 by qupaya
