AiDocs 1.0.3

AiDocs

AI-powered API documentation for ASP.NET Core. Drop it into any project with Swagger/OpenAPI and get a full documentation UI with Claude-assisted endpoint analysis, interactive testing, and more.

Features

• Endpoint Explorer — Browse all API endpoints grouped by controller/tag with search and filtering
• AI-Powered Analysis — Claude reads your Swagger spec, XML comments, and source code to generate deep endpoint explanations
• Interactive Try It Panel — Test endpoints directly from the UI with parameter inputs, request body editor, and syntax-highlighted responses
• AI Payload Generation — One-click AI-generated realistic request payloads based on your endpoint schema
• Documentation Editor — Write and edit per-endpoint and overview documentation with Markdown support
• Changelog & Versioning — Track every documentation edit with diffs and one-click restore to any previous version
• AI Chat — Ask questions about your API in a chat panel with full Markdown rendering
• Dark / Light Theme — Toggle between themes, preference saved to localStorage
• Resizable Sidebar — Drag to resize, collapse for full-width view
• Copy Response — One-click copy of API responses to clipboard
• Multi-Tenant — Documentation is scoped per application name, so multiple projects can share one database
• Zero Config UI — Single embedded HTML page, no static files to serve

Installation

dotnet add package AiDocs

Quick Start

1. Register services in Program.cs

using AiDocs.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Add Swagger (required)
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

// Add AiDocs
builder.Services.AddAiDocs(builder.Configuration);

var app = builder.Build();

app.UseSwagger();
app.UseSwaggerUI();

// Map AiDocs endpoints
app.MapAiDocs();

app.Run();

2. Configure in appsettings.json

{
  "AiDocs": {
    "RoutePrefix": "aidocs",
    "SwaggerJsonPath": "/swagger/v1/swagger.json",
    "ClaudeBaseUrl": "https://api.anthropic.com",
    "ClaudeApiKey": "your-claude-api-key",
    "ClaudeModel": "claude-sonnet-4-6",
    "ConnectionString": "your-sql-server-connection-string",
    "ApplicationName": "MyApi"
  }
}

3. Navigate to /aidocs

Open your browser and go to https://localhost:5001/aidocs (or whatever port your app runs on).

Configuration Options

Database

AiDocs uses SQL Server to persist documentation. Tables are auto-created on startup:

• AiDocsOverview — API overview documentation
• AiDocsEndpointDocumentation — Per-endpoint documentation
• AiDocsChangeLog — Version history with full content snapshots

If you prefer to create them manually:

CREATE TABLE AiDocsOverview (
    Id UNIQUEIDENTIFIER NOT NULL DEFAULT NEWID() PRIMARY KEY,
    ApplicationName NVARCHAR(500) NOT NULL DEFAULT 'Default',
    Content NVARCHAR(MAX) NOT NULL,
    LastUpdated DATETIMEOFFSET NOT NULL DEFAULT SYSDATETIMEOFFSET()
);

CREATE TABLE AiDocsEndpointDocumentation (
    Id UNIQUEIDENTIFIER NOT NULL DEFAULT NEWID() PRIMARY KEY,
    ApplicationName NVARCHAR(500) NOT NULL DEFAULT 'Default',
    EndpointId NVARCHAR(500) NOT NULL,
    HttpMethod NVARCHAR(10) NOT NULL,
    Route NVARCHAR(1000) NOT NULL,
    Documentation NVARCHAR(MAX) NOT NULL,
    LastUpdated DATETIMEOFFSET NOT NULL DEFAULT SYSDATETIMEOFFSET(),
    CONSTRAINT UQ_AiDocsEndpointDoc_App_Endpoint UNIQUE (ApplicationName, EndpointId)
);

CREATE TABLE AiDocsChangeLog (
    Id UNIQUEIDENTIFIER NOT NULL DEFAULT NEWID() PRIMARY KEY,
    ApplicationName NVARCHAR(500) NOT NULL DEFAULT 'Default',
    DocumentationType NVARCHAR(50) NOT NULL,
    EndpointId NVARCHAR(500) NULL,
    Version INT NOT NULL,
    Content NVARCHAR(MAX) NOT NULL,
    CreatedAt DATETIMEOFFSET NOT NULL DEFAULT SYSDATETIMEOFFSET()
);
CREATE INDEX IX_AiDocsChangeLog_Lookup
    ON AiDocsChangeLog (ApplicationName, DocumentationType, EndpointId, Version DESC);

Frameworks

• .NET 8.0
• .NET 9.0

Dependencies

• Dapper — Lightweight ORM for SQL Server
• Microsoft.Data.SqlClient — SQL Server data provider

License

MIT