Features
UI features
What the docs UI ships with — route browser, detail panel, flow runner.
Route browser
- Sidebar groups routes by section (from
groupsconfig) or by first path segment - Color-coded method pills — GET, POST, PUT, PATCH, DELETE
- Property-count badge on routes with defined schemas
- Lives in its own Routes tab when flows are also enabled
Route detail panel
- Full schema tree for request body, query params, path params, and response
- Error responses — colour-coded by status class, with optional body schema
- Optional fields shown with
?suffix - Copy as cURL — ready-to-run curl command with example values filled in
- Copy for LLM — structured markdown description of the endpoint (useful for AI-assisted development)
- Export to Postman — downloads a Postman Collection v2.1 JSON; error responses are included as saved example responses
Flow runner
- Dedicated Flows tab, separate from route documentation
- Built-in authoring guide with JSON examples
- Flow creator — assemble steps from documented routes, insert placeholders, map path params
- Capture prior response fields and convert them to
extractrules automatically - Run flows inside the UI with live input collection and
baseUrloverride - Visual execution timeline with per-step request/response details
- Raw JSON output from the shared runner
- Same format works with the
doctreen-flowCLI
Drift tab
- Per-route badges with mismatch counts
- Latest sample for each route
- Hourly and 7-day rolling buckets
Theming
DocTreen's docs UI uses CSS custom properties for colours. Override them by
injecting CSS via headHtml:
expressAdapter(app, {
meta: { title: 'My API', version: '1.0.0' },
headHtml: `
<style>
:root {
--doctreen-accent: #10b981;
}
</style>
`,
});