How to convert json to a markdown api documentation table
- Step 1Paste a JSON sample response or schema — Paste a representative JSON API response or a JSON Schema object. Top-level keys become the table rows with their values used to infer the Type column.
- Step 2Choose table column layout — Select the columns to include — Field, Type, Required, Example, Description. For basic docs, Field + Type + Description is the most useful starting point.
- Step 3Handle nested objects — Enable 'Flatten nested' to show nested keys as dot-notation rows (user.name, user.email) in a single table, or 'Sub-table' to generate a separate Markdown table for each nested object.
- Step 4Copy and paste into your documentation — Copy the Markdown output and paste it into your README.md, Notion doc, Confluence page, or directly into an OpenAPI description field. GitHub, GitLab, and most Markdown renderers display the table correctly.
Frequently asked questions
How do I add descriptions for each field in the table?+
The converter populates the Description column with the field's value as an example by default. To add custom descriptions, switch to 'JSON Schema' input mode — JSON Schema's description property is mapped directly to the Description column in the table.
Will the Markdown table render correctly on GitHub?+
Yes. The output uses GitHub-flavoured Markdown (GFM) table syntax with pipe separators and a header divider row of dashes. It renders correctly on GitHub, GitLab, Bitbucket, Notion, Confluence, and any Markdown editor that supports GFM tables.
Is the API response data transmitted to JAD Apps?+
No. The conversion runs entirely in your browser. Proprietary API response schemas, internal field names, and sample data are never transmitted to JAD Apps servers.
Privacy first
Conversion runs locally in your browser. No file is uploaded — only metadata counters are saved for signed-in dashboard stats.