Skip to content

Commit 4d39237

Browse files
md file
1 parent d498862 commit 4d39237

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This file describes a VS Code extension command called `devdocs.generateAPIDocumentation` that automatically generates API documentation from a codebase. The command analyzes the code to identify API routes and creates two main outputs:
7+
8+
1. A Postman Collection JSON file containing all detected API routes.
9+
2. An OpenAPI (Swagger) specification file for the API.
10+
11+
The document explains the benefits of using this command, including keeping documentation synchronized with code, saving time, improving developer experience, and facilitating testing and collaboration.
12+
13+
It also outlines the relevant configuration options in the `dev-docs.json` file, prerequisites for using the command, and step-by-step instructions on how to use it within VS Code.
14+
15+
Overall, this file serves as a guide for developers to understand and utilize the automatic API documentation generation feature provided by this VS Code extension.
16+
17+

0 commit comments

Comments
 (0)