Smart Endpoint Watcher

A VS Code extension for js/ts project to discover, test, and document API endpoints directly from your source code.

Features

• Detect Endpoints Automatically scans your Express.js/Node.js routes (app.get, app.post, etc.) and adds CodeLens actions above them.

• Test Endpoints Run requests against your running API server (http://localhost:3000/...) and see results in VS Code.

• Show Info Quickly view method + path of an endpoint inline.

• Generate Docs Create or update an API_DOCS.md file with endpoint details + your descriptions.

  • Each endpoint gets its own section.
  • Updating the same endpoint overwrites its section (no duplicates).

Getting Started

1. Install the extension.
2. Open a project with an Express.js server.
3. Hover over your route definitions (app.get, app.post, etc.).
4. Use the CodeLens commands above the route.

API Docs Workflow

1. Click Show Docs above an endpoint.
2. Enter a short description.
3. API_DOCS.md is updated with the endpoint section.

Requirements

• Node.js + an Express server running (e.g., node server.js).
• VS Code 1.102.0 or higher.

Roadmap

• [ ] Support for POST/PUT body schema in docs.
• [ ] Swagger/OpenAPI export.
• [ ] Integration with REST Client / Thunder Client.

Contributing

Pull requests and feedback are welcome! You can fork this repo and submit issues or feature requests.

License

MIT License © 2025 \alyas