OpenAPI Scanner on Desktop

Generates an OpenAPI 3.1 file (openapi.json) from your backend project folder, without running the API or writing the spec by hand.

What the scanner does

1. Explores: Locates files with HTTP routes (controllers, routes/, handlers/, Program.cs, etc.).
2. Extracts: Retrieves methods, paths and DTOs/models for components.schemas.
3. Generates: Creates openapi.json with an analysis summary.
4. Uploads: Allows uploading the file directly to a Capydox web workspace.

The default flow is structural scanning: fast, CPU-only, no AI model required.

Quick usage guide

1. Open: Go to Scan OpenAPI in the side menu.
2. Folder: Click Choose project folder and select the repository root.
3. Analyze: Click Analyze API and wait for the result card to appear.
4. Result: Review the summary and copy or import the generated openapi.json.
5. Upload (optional): Select a workspace and click Upload OpenAPI.

Compatible stacks

The engine automatically recognizes the following ecosystems:

• Java: Spring Boot
• PHP: Laravel
• Node: Express, Fastify, NestJS, Hono
• Python: Django REST, FastAPI, Flask
• Go: Gin, Echo, Chi
• Rust: Axum, Actix
• C#: ASP.NET Core

Advanced options: Infer schemas with AI

Feature	Structural scan	+ Optional AI
HTTP routes	Yes	Yes
DTOs/Models	If in repo	Yes + extra inferred sample
Model (~4GB)	Not needed	Required
Privacy	Fully local	See privacy

Best practices

• Point to the API root folder, not the full monorepo.
• Use standard file names (*Controller.java, routes/*.js, etc.) to facilitate detection.
• AI should only be enabled if types are missing and you have no native sources (like SpringDoc).

Cleanup

Clean artifacts lets you delete old analyses (older than 7 days) saved to local disk.