Frequently asked questions

Apidoke is a platform for writing, previewing, and publishing interactive API documentation. You author your API in the open API Blueprint format, preview it live in a split editor, and publish a three-column reference with a built-in try-it console.

Developers and API teams who want clean, interactive documentation without setting up a static-site generator, repository, or CI pipeline. If you’ve used Apiary, Apidoke will feel familiar.

API Blueprint is an open, Markdown-based language for describing web APIs. Apidoke uses the API Blueprint 1A format, so your documentation is portable plain text you fully control.

Apidoke documents are authored in API Blueprint, not OpenAPI/Swagger. If you’re coming from OpenAPI, you describe your endpoints in API Blueprint’s Markdown-based syntax, there’s a short guide linked from the editor.

The editor is split: you type API Blueprint on the left and the rendered reference updates on the right as you go. You can switch to editor-only or preview-only at any time.

Yes. Apidoke auto-saves as you type and also lets you save manually with a comment. Every save creates a version you can restore later.

Toggle a project to public and it’s immediately live at a clean, shareable URL, no build step or deploy. Keep it private while you’re still drafting.

Yes. Apidoke keeps a version history per project (up to 50 versions). You can restore any previous version in one click, and your current draft is snapshotted first.

It turns every documented endpoint into a live request. Readers can set headers, query and path parameters, and a request body, send a real HTTP request, and read the response, including status code, timing and headers.

No. Try-it requests are sent directly from the reader’s browser to your API. Authentication headers and tokens never pass through Apidoke’s servers.

Yes. Apidoke runs as an ASP.NET Core 8 application with a MySQL database, serving the single-page app and API together. You can run it on your own server so your docs and data stay inside your network.

You control visibility per project. Private projects are only visible to you when signed in; public projects are readable by anyone with the link. Nothing is public until you choose to publish it.

Yes, you can create an account and publish docs at no cost. Apidoke is also self-hostable if you prefer to run it yourself.