Question 1

How to embed Docson in a website without a server?

Accepted Answer

You can use the offline usage tutorial from the README, which involves serving files locally, but it requires manual setup to avoid CORS issues since Docson runs client-side. Alternatively, embed it via script tags if schemas are hosted on the same origin.

Question 2

Docson vs Redoc for JSON schema documentation?

Accepted Answer

Docson focuses on interactive, browser-based visualization for JSON Schema v4, while Redoc supports newer OpenAPI versions and offers more out-of-the-box features like server-side rendering. Docson is lighter but less feature-rich for modern API docs.

Question 3

How to document TypeScript interfaces with Docson?

Accepted Answer

Install Typson separately and place it in a 'typson' directory alongside Docson. Then reference your .ts files in Docson URLs, and it will convert interfaces to schemas for documentation, as shown in the Typson example.

Question 4

Does Docson work with JSON Schema v7?

Accepted Answer

No, Docson only supports JSON Schema v4, so features from v7 like 'if-then-else' or 'contentEncoding' are not implemented. You'll need to downgrade schemas or use alternatives for newer versions.

Question 5

How to fix CORS errors when using Docson?

Accepted Answer

Serve Docson and your schemas from the same web server to avoid cross-origin issues, as recommended in the README. For distributed setups, you may need proxy servers or CORS headers on the schema server.

Question 6

Can Docson generate static HTML files?

Accepted Answer

No, Docson dynamically generates documentation in the browser. For static output, you would need to pre-render pages manually or use other tools, as Docson lacks built-in static generation features.

Question 7

What are the alternatives if Docson lacks features I need?

Accepted Answer

Consider tools like JSON Schema Faker for mock data, or documentation generators like jsonschema2md for markdown. For full API docs, Redoc or Stoplight support newer JSON Schema versions and offer more integrations.

Docson

What is Docson?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions