API Documentation Guide

Learn how to generate comprehensive API documentation using AkiraDocs.

Quick Start

Upload API Spec

1. Place your OpenAPI/Swagger spec in:

1_contents/{language_code}/api/apiSpec.json

2. AkiraDocs automatically generates documentation.

Example API Spec

1{
2  "openapi": "3.0.0",
3  "info": {
4    "title": "Sample API",
5    "version": "1.0.0"
6  },
7  "paths": {
8    "/users": {
9      "get": {
10        "summary": "Get users",
11        "responses": {
12          "200": {
13            "description": "Success"
14          }
15        }
16      }
17    }
18  }
19}

Generated Documentation

Automatic Features

  • Interactive API explorer
  • Code samples in multiple languages
  • Request/response examples
  • Authentication documentation

Example Output

1// Example: Get Users
2const response = await fetch('https://api.example.com/users', {
3  method: 'GET',
4  headers: {
5    'Authorization': 'Bearer YOUR_TOKEN'
6  }
7});
8
9const users = await response.json();

Customization

Theme Options

1{
2  "api": {
3    "docs": {
4      "theme": "dark",
5      "syntaxHighlight": true,
6      "showExamples": true
7    }
8  }
9}

Language Selection

1{
2  "api": {
3    "examples": {
4      "languages": ["javascript", "python", "curl"]
5    }
6  }
7}