astroswagger is a powerful VS Code extension that automatically generates OpenAPI/Swagger annotations for your code. Save time documenting your APIs and maintain consistency across your project with intelligent annotation generation.
Features
- 🚀 Automatic Swagger Annotation Generation - Generate professional OpenAPI/Swagger annotations with a single command
- ⚡ Fast & Efficient - Quick annotation generation to speed up API documentation
- 📝 Code Integration - Seamlessly integrates with your existing codebase
- 🎯 Smart Detection - Intelligently identifies API endpoints and parameters
- 🔄 Easy Updates - Update and maintain swagger annotations effortlessly
Installation
- Open VS Code
- Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
- Search for "astroswagger"
- Click Install
Or install directly from Visual Studio Marketplace
Usage
Generate Swagger Annotations
- Open the file containing your API code
- Use the keyboard shortcut: Ctrl+Alt+S (Windows/Linux) or Cmd+Alt+S (Mac)
- Or run the command: astroswagger: Generate Swagger Annotations from the Command Palette (Ctrl+Shift+P)
The extension will analyze your code and generate appropriate Swagger/OpenAPI annotations.
Open Documentation
- Run command: astroswagger: Open Documentation to access the full documentation
Keyboard Shortcuts
| Action | Windows/Linux | macOS |
|---|---|---|
| Generate Swagger Annotations | Ctrl+Alt+S | Cmd+Alt+S |
Requirements
- VS Code 1.117.0 or higher
- Any text editor compatible file
Supported Languages
- GO
Configuration
astroswagger works out of the box with minimal configuration required. The extension automatically detects your code structure and generates appropriate annotations.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
MIT - See LICENSE file for details
Author
Yassine MANAI