The version the spec never learned about
A service ships /v2/invoices while the checked-in spec still documents only /v1/invoices. Specs are written once; routing changes continuously, and updating a separate file competes with feature work.
For existing backend projects
APIScout discovers backend endpoints from source code and exports an OpenAPI YAML or JSON baseline without asking you to document every route by hand.
router.get("/accounts",
requireAuth, handler);
src/routes/accounts.ts:18
The problem
Maintaining a hand-written API specification is easy to defer and difficult to trust. Once routes are spread across routers and controllers, rebuilding the spec manually becomes a separate project.
Built for Backend developers, SaaS founders, and indie hackers who need to understand the implementation before they trust the documentation.
Why this happens
A service ships /v2/invoices while the checked-in spec still documents only /v1/invoices. Specs are written once; routing changes continuously, and updating a separate file competes with feature work.
Before an integration, someone copies routes from several controllers into a document. Prefixes, path parameters, and recently added endpoints are easy to miss when the transcription is by hand.
Client generation, documentation portals, and API testing tools all inherit a spec's omissions. A file that is 90% accurate produces tooling that is confidently wrong about the other 10%.
How APIScout solves it
APIScout runs inside VS Code and reads the backend source tree locally. It turns route discovery into an inspectable inventory, then exports OpenAPI when the API needs to move into documentation, testing, or security workflows.
Scan the backend source locally in VS Code.
Review discovered paths and methods with source context.
Export OpenAPI YAML or JSON as a working baseline.
Benefits by role
Generate an OpenAPI starting point from the code you are maintaining, then refine descriptions where editorial detail matters.
Use one exportable baseline for documentation, client-facing discussions, and internal handoffs instead of competing route lists.
A current specification makes it practical to scope automated testing to the endpoints implemented today.
In practice
Regenerate after route-level changes, not only before external releases.
A spec generated once is a snapshot, not a process.
Treat code-derived paths as the baseline and enrich descriptions deliberately.
Generated output is not a substitute for semantics and examples.
Check the export covers version prefixes and newer modules before publishing.
Don't assume coverage because the file parses.
FAQ
It is a source-backed baseline. Add business descriptions, examples, and audience guidance — the parts route implementation cannot express.
Hand-authored specs can be excellent, but they drift when updates sit outside the development workflow. APIScout lowers the cost of recovering a current route inventory.
OpenAPI YAML and JSON, so the result works with documentation, testing, and API tooling that accepts standard OpenAPI input.
When APIScout is not enough
An OpenAPI document describes an intended interface, not all runtime behavior. Use contract tests, integration tests, and security testing to validate how the deployed API behaves.
How ApyGuard extends the workflow
A generated spec is ready to import into ApyGuard when you want to continue from API documentation into automated API security testing.
APIScout for VS Code
Install the free, local-first extension to discover backend endpoints, inspect their source context, and export an OpenAPI baseline when the workflow needs one.
Install APIScout — Free