ApiDeck.AspNetCore 5.0.2

⚡ ApiDeck.AspNetCore v5.0.0

The high-performance, framework-agnostic API explorer and documentation generator for ASP.NET Core.

Zero external dependencies. Zero bloat. Blazing fast.

💡 Why ApiDeck?

ApiDeck fundamentally reimagines how API documentation is generated and served. Instead of relying on heavy OpenAPI pipelines, ApiDeck builds its own optimized API metadata directly from ASP.NET Core's IApiDescriptionGroupCollectionProvider — no Microsoft.AspNetCore.OpenApi dependency, no Swashbuckle, no NSwag.

The result is a dramatically faster spec generation pipeline, a dramatically smaller footprint, and a premium developer experience natively built for the modern web.

🚀 Quick Start

1. Install

Install the package via the .NET CLI:

dotnet add package ApiDeck.AspNetCore

2. Register Services and Middleware

Add ApiDeck to your application builder.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();

// Add ApiDeck (No AddOpenApi() needed)
builder.Services.AddApiDeck(); 

var app = builder.Build();

// Enable the middleware to serve the UI and Spec
app.UseApiDeck(); 
app.MapControllers();

app.Run();

3. Open Documentation

Fire up your application and navigate to the default documentation route:

https://localhost:<port>/apideck

Done. Two lines of code. No complex configuration required. Both the API specification and the rich HTML interface are ready to go.

✨ What's New in v5.0.0

💻 Multi-Language Code Snippet Generator

• Generate ready-to-copy code snippets for any endpoint:
  • JavaScript: fetch, axios
  • PHP: Guzzle, cURL
  • C#: HttpClient
• 1-click clipboard copy with URL, parameters, headers, and JSON body.

📜 Request History & Replay Log

• Full execution audit log (History button in topbar).
• View past requests with status code badges (200 OK, 404, 500), latency metrics (ms), and timestamps.
• 1-Click Replay & Restore: Click any past request card to restore parameters, body text, custom headers, and server response.

⚡ Performance Load Tester & Stress Benchmarking

• Built-in load testing tool (Stress Test button in execute bar).
• Run 10, 50, or 100 requests sequentially or in parallel.
• Displays Average Latency (ms), P95/P99 Percentile Latency, Success Rate %, and an interactive visual latency chart.

📦 Postman Collection & OpenAPI Export / Import

• Postman v2.1 Export: Export your API schema as a native Postman v2.1 JSON Collection for instant import into Postman.
• OpenAPI / Postman Importer: Import external OpenAPI 3.0 or Postman JSON specifications directly into browser memory.

🗺️ Interactive API Route & Schema Node Visualizer

• Interactive SVG canvas map (Visualizer button in topbar).
• Visualizes API Root, Feature Groups, Endpoints, and Schemas with animated bezier curve edges.
• Click any endpoint node in the visualizer to navigate directly to its playground details.

🔤 Dual Collection & Endpoint Alphabetical Sorting

• Sort toggle button in sidebar now sorts both Collections/Groups AND Endpoints inside each group (A-Z or Z-A).

💾 Complete Per-Endpoint State Retention

• Inputs, JSON body text, custom headers, and server response results stay saved when navigating between different endpoints.

⚙️ Configuration Options

Tailor ApiDeck exactly to your organizational needs.

app.UseApiDeck(options =>
{
    // Change the base URL fragment
    options.RoutePrefix = "api-docs";     // Default: "apideck"
    
    // Customize the documentation title
    options.Title = "Internal Microservices"; // Default: "ApiDeck"
    
    // Toggle the UI Dark Mode baseline preference
    options.DarkMode = true;             // Default: false
});

📌 Diagnostic Toolkit

Gain insight into your API ecosystem at a glance. Navigate to /apideck/diagnostic (using your defined RoutePrefix) to access:

• Rapid enumeration of discovered endpoints, defined groups, and extracted schemas
• Verification of background service and provider registrations
• Easy fallback diagnostic validation to guarantee DI health

📋 Compatibility

📄 License & Contribution

MIT © Muammar Siddiqui.

Feel absolutely free to fork, clone, and deploy ApiDeck in your private, commercial, and open-source stacks.