---
title: Reusable Guide
slug: video-tutorials
createdAt: 2026-08-21T13:59:59.983Z
---

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

![](https://api.archbee.com/api/optimize/nnXudRKm4KkQ_ECeAi3d2/mc_9aFJo-brflB0P6GK5x_slack.png)

## Overview

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.

## Options for documenting your API

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

### 1. Manual endpoint documentation

Create handcrafted pages for each endpoint using blocks like:

- **ApiMethodV2** — Rich interactive endpoint documentation (path, parameters, responses)
- **Tabs** — Show code samples in multiple languages
- **Code blocks** — Add sample requests or responses
- **Callouts** — Highlight important warnings or usage tips

This approach gives you full control over formatting and explanations.

### 2. Import your OpenAPI specification (recommended)

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

::::ExpandableHeading
### Scalar (interactive API explorer)

:::Scalar
```json
{
  "jsonFileLocation": "https://petstore.swagger.io/v2/swagger.json",
  "headers": []
}
```
:::


::::

::::ExpandableHeading
### Swagger UI embed

This method ensures your docs stay in sync with your API as long as you update the spec.

:::Swagger
```json
{
  "jsonFileLocation": "https://petstore.swagger.io/v2/swagger.json",
  "headers": []
}
```
:::


::::

### 3. Embed external API docs

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

:::Iframe{code="<iframe src='https://example.com/api/docs' width='100%' height='500'></iframe>"}

:::

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

## Blocks available for API documentation

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

### ApiMethodV2

Create full endpoint documentation with structure for:

- Path
- Method
- Parameters
- Responses
- Code samples

### Scalar (OpenAPI)

Embed an interactive API explorer sourced from your OpenAPI JSON.

### Swagger

Render your OpenAPI spec with Swagger UI.

### Tabs

Use tabs to present code samples in different programming languages.

### Code blocks

Show requests, responses, or implementation examples.

### Callouts

Highlight warnings, notes, deprecations, or usage tips.

### Iframe

Embed external API docs or third‑party developer tools.

## Choosing the right approach

Use this quick guide to decide:

- **Your API already has an OpenAPI spec →** Use **Scalar** or **Swagger** blocks.
- **You want complete control over how each endpoint is presented →** Use **ApiMethodV2**.
- **Your API docs already live elsewhere →** Embed them with an **Iframe**.
- **You have mixed use cases →** Combine these approaches.

## What to read next

- **API overview** – Learn how your API is structured
- **Example endpoint** – See a full endpoint template
- **Authentication** – Required for accessing protected endpoints
- **Error codes** – Common responses and troubleshooting guidance