apitestspec-surface-scan

To generate API documentation from backend source code, scan the repository to identify HTTP endpoints and export them as structured Markdown or JSON files. This approach quickly inventories endpoints without requiring formal documentation.

You can extract HTTP endpoints from a Java or Go project by scanning the backend source code to identify route definitions. The tool infers endpoint details directly from the code and exports a readable inventory.

Yes, you can target specific modules rather than scanning an entire repository. The scanning process supports filtering by module scope and optional URL prefix to narrow down the identified HTTP endpoints.

No, endpoint discovery from code avoids fabricating request and response structures. It infers endpoint details directly from existing source code definitions to ensure the exported Markdown or JSON documentation reflects actual behavior.

The best way to discover API endpoints without formal documentation is to scan backend source code like Python or Node.js projects. This automatically identifies route definitions and exports a clear checklist for review.

To prepare for test generation after discovering API endpoints, export the scanned route inventory as Markdown or JSON. This output can then be handed off to a spec composer to generate subsequent test cases.