Interactive API docs, rendered from your spec.
Give the teams integrating with your API docs they can actually use: every endpoint and event, working examples, and auth, generated from your OpenAPI or AsyncAPI spec so they never go stale. Drop in the whole page, a single endpoint or section, or just the pieces your site needs.
Why apiuikit
Docs that ship with your API, not after it.
Hand-written docs drift the moment the API changes, and building your own docs takes weeks. apiuikit reads the spec you already maintain, so your docs stay accurate without anyone having to own them.
- 2
- Kinds of API
- REST APIs from OpenAPI and event-driven APIs from AsyncAPI, documented the same way.
- 3
- Data formats
- JSON, Avro, and Protobuf payloads, with nothing extra to install.
- 5 +
- Frameworks
- Fits whatever your site is built with: React, Vue, Angular, Svelte, or plain HTML.
Build your own
10+ building block sections, straight from your spec
Use any of them into your own pages on their own.
Every event integrators can send or receive.
Each one comes with its payload, examples, and replies attached, generated from the spec so the docs never drift from what you ship.
import { AsyncAPIOperation } from "apiuikit";
<AsyncAPIOperation
document={doc}
operationId="subscribe"
config={{ show: { tryIt: true } }}
/>Plugins
Endless possibilities.
Add your own custom functionality to the doc using plugins.
Drop your own React components into operation tabs, inline beside the reference, or the document top bar. The red button is one — go on, press it.
Theme engine
Your brand, on every page.
Pick one of 13 presets or set your own colors, for light and dark. Every section follows, with no CSS to write.
Presets
How you use it
Four ways to use it.
Start with the whole widget, drop in one section or one item, or compose several. Same API, whatever granularity your layout needs.
import { AsyncAPI } from "apiuikit";
import "apiuikit/style.css";
import doc from "./asyncapi.json";
export default function App() {
return <AsyncAPI asyncapi={doc} />;
}No build step
apiuikit from your terminal.
Generate or serve API documentation directly from an AsyncAPI or OpenAPI document, without wiring up a React app.
One command turns a spec file into a static site you can open from disk or publish anywhere — built for Spring, Go, and Python services, docs-only repos, and CI pipelines.
Explore the CLI- Spec type
- OpenAPI
- Title
- Swagger Petstore - OpenAPI 3.0
- Output
- apiuikit-docs
Getting it in
Incremental, not all-or-nothing.
Start with one endpoint in a page you already have. Add more when you need them.
Get help from the maintainers.
apiuikit is free and open source. We can help you integrate it, adopt AsyncAPI or OpenAPI across your team, and work through theming or migration questions.