Your intelligent documentation proxy. Automatically generates beautiful, interactive API docs from your Express.js code, right inside VSCode.
Doxy scans your workspace for Express.js routes, infers schemas from JSDoc comments, and presents a stunning OpenAPI-based documentation panel that updates in real-time as you code.
✨ Features
🚀 Automatic Detection: Finds app.get(), app.post(), etc., in your JavaScript/TypeScript files.
⚡ Real-time Updates: Documentation refreshes instantly when you save a file.
🎨 Beautiful UI: Interactive documentation powered by Swagger UI, styled with the clean Doxy design language.
🧠 Smart Inference: Parses JSDoc comments (@param, @returns, @summary, @body) to build a rich OpenAPI spec.
📦 One-Click Export: Generate a standalone HTML file or an OpenAPI 3.0 JSON specification to share with your team.
🔎 Integrated Preview: View your API docs in the VS Code activity bar without leaving your editor.
🔧 Zero Configuration: Works out of the box. Just install and open an Express.js project.
🚀 Getting Started
Install: Install the "Doxy - Smart API Documentation" extension from the VSCode Marketplace.
Open Project: Open a folder or workspace containing your Express.js application.
View Docs: Click the new Doxy icon in your activity bar. Your API documentation will appear and automatically update as you work.
✍️ Documenting Your Code
Doxy uses JSDoc comments to create rich documentation. Add a comment block above your route definition:
/**
@summary Get a specific user
@description Retrieves a user object by their unique ID.
@tags Users
@param {string} id.path.required - The user's unique ID.
@returns {User} 200 - The found user object.
@returns {Error} 404 - User with the specified ID was not found.
*/
app.get('/users/:id', (req, res) => {
// ... your logic here
});
