Reusable Guide

Use this page as a guide for documenting your API effectively. It outlines the different approaches you can take inside Archbee and the blocks available to help you build a clear, developer‑friendly API reference.

Add a new line

Archbee provides several ways to document APIs, ranging from fully manual endpoint pages to automatically generated reference sections using your OpenAPI specification. Choose the approach that fits your workflow and your team’s level of automation.

There are three main ways to build API documentation in Archbee:

Create handcrafted pages for each endpoint using blocks like:

This approach gives you full control over formatting and explanations.

Use your existing OpenAPI (Swagger) JSON to auto‑generate interactive reference docs. Archbee supports two blocks for this:

If your API documentation is hosted externally, you can embed it directly via iFrame:

This is useful if you already maintain API docs in another system.

Here are the primary blocks you can use when creating custom API documentation:

Create full endpoint documentation with structure for:

Embed an interactive API explorer sourced from your OpenAPI JSON.

Render your OpenAPI spec with Swagger UI.

Use tabs to present code samples in different programming languages.

Show requests, responses, or implementation examples.

Highlight warnings, notes, deprecations, or usage tips.

Embed external API docs or third‑party developer tools.

Use this quick guide to decide: