Introduction

Modern API documentation that developers love

Bytedocs is a modern, intelligent API documentation tool that automatically generates beautiful, interactive documentation for your APIs. Think of it as Swagger/OpenAPI on steroids – with zero configuration, AI-powered assistance, and advanced testing capabilities.

What is Bytedocs?

Bytedocs transforms your API code into comprehensive, interactive documentation without requiring manual annotations or configuration. It's designed for modern development workflows where documentation should be automatic, accurate, and delightful to use.

Key Highlights

🚀 Zero Configuration - Add one line of code, get full documentation
🤖 AI-Powered - Built-in AI assistant that understands your API
⚡ Auto-Detection - Automatically discovers routes, parameters, and schemas
🎨 Beautiful UI - Modern, responsive interface that works on any device
🧪 Advanced Testing - Interactive testing, scenarios, and K6 performance tests
🌍 Multi-Language - Consistent experience across Go, PHP, Node.js, Python, and Rust

Why Bytedocs?

Traditional API Documentation Problems

Traditional tools like Swagger require extensive manual annotations:

// ❌ Traditional Swagger - Lots of boilerplate
// @Summary Get user by ID
// @Description Get a single user by their unique identifier
// @Tags users
// @Accept json
// @Produce json
// @Param id path int true "User ID"
// @Success 200 {object} User
// @Failure 404 {object} ErrorResponse
// @Router /users/{id} [get]
func getUser(c *gin.Context) {
    // handler code...
}

The Bytedocs Way

With Bytedocs, just write clean code:

// ✅ Bytedocs - Clean code, auto-documented
func getUser(c *gin.Context) {
    var user User
    id := c.Param("id")
    // Bytedocs automatically detects:
    // - Route: GET /users/:id
    // - Parameter: id (path, string)
    // - Response: User struct (200)
    c.JSON(200, user)
}

Core Features

1. Automatic Route Detection

Bytedocs uses Abstract Syntax Tree (AST) analysis to automatically discover:

All registered routes and HTTP methods
Path parameters, query strings, headers
Request body structures and validation rules
Response types and status codes
Documentation from code comments

2. AI Assistant

Built-in AI chat that understands your entire API:

Answers questions about endpoints
Suggests optimal usage patterns
Helps debug integration issues
Supports OpenAI, Google Gemini, Anthropic Claude, and OpenRouter

3. Interactive Testing

Test your API directly from the documentation:

Execute requests with custom parameters
See real-time responses
Save request history
Export as cURL or code snippets

4. Scenario Testing

Create reusable test scenarios with multiple endpoints:

{
  "name": "User Registration Flow",
  "requests": [
    { "method": "POST", "path": "/auth/register" },
    { "method": "POST", "path": "/auth/verify-email" },
    { "method": "GET", "path": "/users/me" }
  ],
  "execution_mode": "sequential"
}

5. Performance Testing (Laravel)

Integrated K6 load testing:

Configure virtual users and duration
Run stress tests from the UI
View detailed performance metrics
Identify bottlenecks

6. OpenAPI 3.0.3 Export

Generate standard OpenAPI specifications:

JSON and YAML formats
Import into Postman, Insomnia, etc.
Use with code generation tools
Share with external teams

Supported Languages & Frameworks

Bytedocs supports the most popular backend frameworks:

Go

Gin
Echo
Fiber
Gorilla Mux
Standard net/http

PHP

Laravel

Node.js

Express
Fastify
NestJS
Hono
Koa
AdonisJS

Python

FastAPI
Flask
Django

Rust

Axum
Warp (planned)
Actix-web (planned)

How It Works

Rendering Chart

Code Analysis: Bytedocs parses your source code using AST
Route Detection: Discovers all endpoints from your framework's routing
Type Inference: Extracts request/response schemas from your types
Schema Generation: Builds OpenAPI 3.0.3 compatible schemas
UI Rendering: Serves a beautiful React-based interface
Runtime Features: Enables testing, AI chat, and scenarios

Quick Comparison

Feature	Bytedocs	Swagger	Postman
Auto-detection	✅ Full	⚠️ Partial	❌ Manual
Setup Time	< 1 minute	30+ minutes	Hours
Annotations Required	❌ None	✅ Many	✅ Manual
AI Assistant	✅ Built-in	❌ No	❌ No
Performance Testing	✅ K6 Integration	❌ No	⚠️ Limited
Scenario Testing	✅ Advanced	❌ No	✅ Basic
Modern UI	✅ React	⚠️ Dated	✅ Modern
OpenAPI Export	✅ Yes	✅ Yes	⚠️ Limited