Introduction to APIDock

Welcome to APIDock! This guide will help you get started with creating beautiful, developer-friendly API documentation.

New to APIDock? Start with our Quick Start Guide to have your first docs live in under 5 minutes.

What is APIDock?

APIDock is a modern API documentation platform that helps you create beautiful, interactive documentation that developers actually want to use. Import your OpenAPI spec or write docs from scratch—either way, you'll have production-ready documentation in minutes.

Key Features

OpenAPI Import: Generate docs from your OpenAPI 3.0 or Swagger specs
Live API Testing: Let developers test endpoints directly from your docs
Code Samples: Auto-generated snippets in 10+ programming languages
Custom Branding: Match your docs to your brand identity
Analytics: Understand how developers use your documentation

Quick Start

Get your first API documentation project up and running in three steps:

Step 1: Create a Project

Sign up for APIDock and create your first project. You can start from scratch or import an existing OpenAPI specification.

# Using the APIDock CLI
apidock init my-api-docs
cd my-api-docs

Step 2: Configure Your API

Add your API endpoints, parameters, and response schemas. APIDock will automatically generate code samples and a testing playground.

# apidock.yaml
name: "My API"
version: "1.0.0"
base_url: "https://api.example.com"

endpoints:
  - path: "/users"
    method: "GET"
    description: "List all users"

Step 3: Deploy

Push your changes and APIDock will automatically build and deploy your documentation.

apidock deploy

Note: Make sure you have the APIDock CLI installed. Run npm install -g @apidock/cli to install it.

Next Steps

Now that you have your first project set up, explore these topics to get the most out of APIDock:

Customize your branding - Add your logo, colors, and fonts
Set up a custom domain - Use your own domain for docs
Enable analytics - Track how developers use your docs
Connect to GitHub - Auto-deploy on every push