openapi-source-recon

Scans source code to map HTTP routes, auth schemes, and schemas for OpenAPI generation.

9|2|Updated Jul 15, 2026
One-click install
npx skills add https://github.com/IgorSasovets/devsecops-with-claude --skill openapi-source-recon-igorsasovets
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openapi-source-recon
Source: https://github.com/IgorSasovets/devsecops-with-claude/tree/main/openapi-spec-creator/.claude/skills/OPENAPI_SOURCE_RECON
Command: npx skills add https://github.com/IgorSasovets/devsecops-with-claude --skill openapi-source-recon-igorsasovets

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing an accurate OpenAPI specification by hand requires manually tracing every route, middleware, validator, and data model in a codebase, which is slow and error-prone for large projects. This Skill automates the reconnaissance stage by scanning a project directory and producing structured artifacts that document the entire API surface. ## Core Features & Use Cases - Multi-language route mapping: Detects endpoints across Express, NestJS, FastAPI, Flask, Django, Spring, Gin, Laravel, Rails, Actix, and more, writing results progressively to routes.json. - Auth and middleware analysis: Identifies JWT, API key, OAuth2, Basic, and session auth schemes, per-route protection status, CORS settings, and middleware chains in auth-map.md. - Schema and validator extraction: Maps path/query parameters, request bodies, response shapes, validation libraries, and data models into schemas.md and validators.md. - Auto-scaling depth: Adjusts scan depth (fast/balanced/deep) based on file count, uses Grep/Glob first for token efficiency, and checks for an existing openapi.yaml to support merge mode. - Use Case: Point it at a legacy Express monorepo with no API documentation; it produces API_RECON.md plus intermediate artifacts that feed directly into the openapi-spec-builder stage to generate a complete openapi.yaml. ## Quick Start Run the openapi-source-recon skill on the ./src directory to map all API endpoints, authentication, and schemas into an API_RECON.md report.

Frequently Asked Questions about openapi-source-recon

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I extract API endpoints from source code for an OpenAPI spec?▼

Run this recon skill against your project root; it greps for framework-specific route patterns (Express app.get, FastAPI decorators, Spring @GetMapping, etc.) and writes every endpoint with method, path, handler, and file location to routes.json.

What frameworks are supported for API route detection?▼

Supported frameworks include Express, NestJS, Fastify, Next.js, Flask, Django, FastAPI, Spring Boot, Ktor, Gin, Echo, Chi, Laravel, Symfony, Rails, Sinatra, Actix, Axum, and Rocket. Language and framework detection runs automatically via Grep without reading files.

Can it merge recon results with an existing openapi.yaml?▼

Yes. During pre-flight it checks for an existing openapi.yaml, shows its title, version, and path count, and offers overwrite, merge, or abort options. In merge mode, known paths are flagged so new endpoints are clearly identified.

Does the scan modify or execute my source code?▼

No. The skill is strictly read-only: it uses Glob, Grep, and limited Bash commands (find, grep, head, jq) to inspect files. It only writes new artifact files into the openapi-spec-creator output directory.

How does it handle very large repositories?▼

Scan depth auto-scales by file count: deep under 200 files, balanced up to 2000, and fast (grep-only) beyond that. Above 5000 files at fast depth it samples recent and random files per language, and --no-deps skips dependency inventory.

What are the limitations of static API recon?▼

Dynamically registered routes, runtime-generated paths, and frameworks using unconventional patterns may be missed since detection relies on grep patterns. At fast depth, schema confidence is lower because no full file reads occur; such routes are flagged for manual review.