Theneo.OpenApiScanner 0.1.0

dotnet add package Theneo.OpenApiScanner --version 0.1.0
                    
NuGet\Install-Package Theneo.OpenApiScanner -Version 0.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Theneo.OpenApiScanner" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Theneo.OpenApiScanner" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="Theneo.OpenApiScanner" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Theneo.OpenApiScanner --version 0.1.0
                    
#r "nuget: Theneo.OpenApiScanner, 0.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Theneo.OpenApiScanner@0.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Theneo.OpenApiScanner&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Theneo.OpenApiScanner&version=0.1.0
                    
Install as a Cake Tool

Theneo.OpenApiScanner

Generate an OpenAPI 3.1 document from an ASP.NET Core project's source code — with zero annotations and zero config. No need to run your API, no Swashbuckle, no attributes on your controllers.

It's the .NET sibling of @theneo/openapi-scanner. To render the generated document in an ASP.NET Core app, pair it with the Theneo.AspNetCore viewer — or use Theneo.AspNetCore.Scanning, which wires this scanner into the viewer at startup with one call.

Status: v1, in development. v1 covers ASP.NET Core controllers. Minimal APIs, gRPC, and GraphQL are on the v0.2 roadmap. See SUPPORTED-PATTERNS.md for the exact ✅/❌ boundary.

How it works

The scanner loads your project with Roslyn (MSBuildWorkspace) and reads the source — it never reflects over compiled assemblies, so a scan is fast, deterministic, and doesn't need your database or other production dependencies available.

CLI

dotnet tool install --global Theneo.OpenApiScanner.Cli

theneo-scan build --project ./src/Api/Api.csproj --out openapi.json
theneo-scan dev   --project ./src/Api/Api.csproj    # rescan on save (watch mode: later build)

Programmatic API

using System.Text.Json;
using Theneo.OpenApiScanner;
using Theneo.OpenApiScanner.Models;

var doc = await Scanner.ScanAsync(new ScannerConfig
{
    ProjectPath = "./src/Api/Api.csproj",
    Info = new OpenApiInfo { Title = "My API", Version = "1.0.0" },
});

File.WriteAllText("openapi.json", JsonSerializer.Serialize(doc, Config.OutputJson));

Config file — theneo-scan.json (optional)

{
  "projectPath": "./src/Api/Api.csproj",
  "info": { "title": "My API", "version": "1.0.0", "description": "..." },
  "servers": [{ "url": "https://api.example.com", "description": "Production" }],
  "outputPath": "openapi.json"
}

CLI flags override config-file values.

License

MIT © Theneo

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Theneo.OpenApiScanner:

Package Downloads
Theneo.AspNetCore.Scanning

Zero-config auto-scan for the Theneo.AspNetCore reference viewer. Adds `MapTheneoApiReferenceWithScanning(...)`, which scans your ASP.NET Core controllers' source with Roslyn at startup and serves the generated OpenAPI document to the viewer — no Swashbuckle, no annotations. Pulls in Roslyn/MSBuild; keep it out of your renderer path unless you want auto-scan.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 130 10/20/2026