Fiskil Docs Guide

API reference

Generated, interactive documentation for your API

Everything under this tab is generated from one OpenAPI file — public/openapi/example-api.json in this template. Each endpoint gets:

  • request and response schemas with expandable nested fields,
  • generated code samples (cURL, JavaScript, Python, Go, and more),
  • a Try it playground that sends real requests,
  • response examples for every status code.

Browse the sample endpoints in the sidebar to see it in action — then make it yours:

1

Add your spec

Put your OpenAPI file (JSON, 3.0+) in public/openapi/, or reference a public URL — it will be downloaded and validated for you.

2

Point docs.json at it

"openapi": {
  "variants": [
    { "id": "example", "label": "Example API", "specs": ["your-api.json"] }
  ]
}

The variant id must match a product id.

3

Need versions?

List multiple spec versions under versions instead of specs — readers get a version dropdown, and old versions show a "you're viewing an old version" banner automatically.

This intro page is yours too

It's a normal Markdown page (content/docs/example/api-reference/index.mdx), pinned above the generated endpoints via introSlugs in docs.json. Use it for authentication instructions, base URLs, and rate limits.

List books