Widdershins
github.com
- Free plan
- Linux
- API
- Self-hosted
What Widdershins is
Widdershins converts API definitions into documentation formats for an API documentation pipeline. It accepts OpenAPI 3.x and 2.0, API Blueprint, AsyncAPI, and Semoasa inputs. The main output is Markdown compatible with Slate and ReSlate; it can also produce HTML directly or use ReSpec format. Integrations are described for Slate, ReSlate, Shins, and ReSpec renderers. Users can customize code samples, including language tabs, and use httpsnippet to generate samples. Output can be changed by editing or overriding the included templates. Widdershins can be installed globally with npm install -g widdershins, or by cloning the repository and running npm i. Node.js applications can call its convert function, which returns a Promise. The project is free, self-hosted, and MIT licensed, with listed platforms including API, Linux, and self-hosted environments. Schema examples default to a maximum depth of 10. Referenced request-body schemas are not expanded by default unless they contain an inline schema. The documentation also covers generated Authorization headers in OpenAPI samples and an option to customize the API key value.
Who it suits
It suits developers building documentation pipelines from API definitions. Teams using Slate, ReSlate, Shins, or ReSpec can use its conversion and template options.
Good to know, and what to watch
- Accepts several API definition formats
- Produces Markdown, HTML, or ReSpec output
- Supports customizable code samples
- Allows template editing and overrides
- Free MIT-licensed open-source software
- Referenced request bodies are not expanded by default
- Schema examples have a depth limit of 10
- No interactive API reference
Plans
Every plan and priceWiddershins
Open source
The verdict
Widdershins is a focused converter between API definitions and documentation formats. Its free, self-hosted workflow is useful when a renderer-based pipeline and customizable output are required.
What the maker publishes
- API use
- Widdershins can be called from Node.js using its convert function, which returns a Promise. source
- Code samples
- It supports customizable code samples, including language tabs, and can use httpsnippet to generate samples. source
- Input formats
- The project describes support for OpenAPI 3.x, OpenAPI 2.0, API Blueprint, AsyncAPI, and Semoasa inputs. source
- Install
- The project can be installed globally with npm install -g widdershins or installed by cloning the repository and running npm i. source
- Integrations
- The README describes using Widdershins with Slate, ReSlate, Shins, and ReSpec renderers. source
- License
- The repository identifies its license as MIT. source
- Limits
- Schema examples default to a maximum depth of 10, and referenced request body schemas are not expanded by default unless they have an inline schema. source
- Output formats
- Widdershins can produce Markdown and can also output HTML directly or use ReSpec format. source
- Pipeline
- It is intended as a stage in an API documentation pipeline, converting API definitions for a renderer. source
- Purpose
- Widdershins converts OpenAPI, Swagger, AsyncAPI, and Semoasa definitions into Markdown compatible with Slate and ReSlate. source
- Security
- The README documents generated Authorization headers in OpenAPI code samples and provides an option to customize the API key value. source
- Templates
- Users can customize output by editing or overriding the included templates. source
Checked against the maker's pages on 4 Oct 2026.