🚀 OpenAPI Spec Master
The ultimate VS Code extension for OpenAPI/Swagger specification analysis, validation, and code generation.
Transform your API development workflow with professional-grade tools for OpenAPI specifications. Built for developers who demand excellence in API design and documentation.
✨ Why Choose OpenAPI Spec Master?
- 🎯 Professional Grade: Enterprise-ready with advanced performance optimizations
- ⚡ Lightning Fast: Optimized for large specifications with intelligent caching
- 🔍 Deep Analysis: Comprehensive validation, analytics, and insights
- 🛠️ Multi-Language: Generate code in TypeScript, JavaScript, Python, cURL, and more
- 📊 Rich Visualizations: Interactive tree views, dependency graphs, and analytics dashboards
- 🎨 Modern UI: Beautiful, VS Code-native interface with dark/light theme support
🎬 Quick Demo
Experience the power of professional API specification management directly in VS Code
🔥 Key Features
🔍 Intelligent Analysis Engine
- Smart Detection: Automatically recognizes OpenAPI 3.0+ and Swagger 2.0 files
- Real-time Validation: Instant feedback with VS Code's native diagnostic system
- Advanced Analytics: Deep insights into API structure, complexity, and patterns
- Security Analysis: Identify authentication gaps and security vulnerabilities
🌳 Rich Interactive Views
- Enhanced Spec Explorer: Modern web-based interface with advanced search and filtering
- Endpoint Browser: Organize and explore API endpoints by tags, methods, or complexity
- Schema Explorer: Navigate complex data models with property details and relationships
- Analytics Dashboard: Visual metrics showing method distribution and API health
🚀 Professional Code Generation
- Multi-Language Support: TypeScript, JavaScript, Python, cURL, and more
- Smart Type Generation: Auto-generate TypeScript interfaces from OpenAPI schemas
- Realistic Mock Data: Create test data that matches your schema constraints
- Export Flexibility: Multiple formats including Markdown, JSON, and HTML documentation
- Intelligent Caching: Fast search and filtering for specifications with 1000+ endpoints
- Lazy Loading: Efficient memory usage for large datasets
- Real-time Monitoring: Performance metrics displayed in VS Code status bar
- Debounced Operations: Smooth user experience with optimized response times
🛡️ Advanced Validation
- Design Best Practices: Check for REST API design standards
- Documentation Coverage: Identify missing descriptions and examples
- Schema Optimization: Detect unused components and circular dependencies
- Compliance Checking: Ensure adherence to OpenAPI specification standards
🔧 Professional Spec Management
- Smart Organization: Create folders to organize your OpenAPI specifications by project, environment, or team
- Multi-Source Loading: Add specs from local files or remote URLs with automatic validation
- Real-time Sync: Keep track of your most important API specifications in one centralized location
- Export/Import Configuration: Backup and share your spec configurations across teams and environments
🎯 Advanced Analysis & Validation
- Comprehensive Validation: Industry-standard OpenAPI 3.0+ validation with detailed error reporting
- Security Analysis: Automated security checks for authentication, authorization, and data exposure
- Performance Insights: Built-in analytics for endpoint complexity, response patterns, and optimization opportunities
- Best Practices: Automated suggestions for API design improvements and consistency
💻 Intelligent Code Generation
- Multi-Language Support: Generate client code in TypeScript, JavaScript, Python, and cURL
- Smart Templates: Context-aware code generation with proper typing and error handling
- Custom Configurations: Configurable output formats and coding standards
- Instant Preview: Real-time code preview with syntax highlighting
- Smart Caching: Advanced caching system for lightning-fast search and filter operations
- Performance Dashboard: Real-time metrics displayed in VS Code status bar
- Lazy Loading: Optimized handling of large API specifications (100+ endpoints)
- Debounced Operations: Smooth user experience with optimized search and update delays
🚀 Enhanced Developer Experience
- Advanced Search: Fuzzy search across endpoints, parameters, schemas, and documentation
- Smart Filtering: Filter by HTTP methods, tags, security requirements, and custom criteria
- Rich Visualizations: Interactive dependency trees and schema relationship diagrams
- Modern UI: Clean, responsive interface with dark/light theme support
📤📥 Configuration Management
- Full Export: Export all folders and specifications for backup or sharing
- Selective Export: Export individual folders or specifications
- Flexible Import: Import configurations with options to replace, merge, or selectively choose items
- Team Collaboration: Share curated API collections with your team
- Version Control: Track and manage different versions of your API specifications
📦 Installation
VS Code Marketplace
- Open VS Code
- Go to Extensions (
Ctrl+Shift+X / Cmd+Shift+X)
- Search for "OpenAPI Spec Master"
- Click Install
Command Line
code --install-extension RyanCardin.openapi-spec-explorer
Manual Installation
- Download the latest
.vsix file from Releases
- Install via VS Code:
Extensions > ... > Install from VSIX
🚀 Quick Start Guide
1. Load Your First Specification
// Open any OpenAPI file (JSON/YAML)
{
"openapi": "3.0.0",
"info": {
"title": "My API",
"version": "1.0.0"
}
// ... your spec content
}
2. Access the Extension
- Sidebar: Click the OpenAPI icon in the Activity Bar
- Command Palette:
Ctrl+Shift+P → "OpenAPI Spec Master"
- Right-click: On any OpenAPI file → "Load OpenAPI Specification"
3. Explore Your API
- Browse endpoints in the Spec Manager
- Use Enhanced View for advanced search and filtering
- Generate code examples with one click
- Export documentation in multiple formats
🎮 Quick Start
📋 Basic Usage
- Open the Activity Bar: Click on the OpenAPI Explorer icon in VS Code's Activity Bar
- Create a Folder: Click the "➕ Create Folder" button in the Spec Manager
- Add Specifications: Use "📁 Add from File" or "🌐 Add from URL" to load your OpenAPI specs
- Explore & Analyze: Click on any spec to view detailed analysis in the Enhanced View
📤 Export Configuration
- Export All: Click the export button (📤) in the Spec Manager title bar to export all folders and specs
- Export Selected: Right-click on any folder or spec and select "Export Selected Items"
- Choose Format: Save as JSON file for easy sharing and backup
📥 Import Configuration
- Import: Click the import button (📥) in the Spec Manager title bar
- Choose Import Mode:
- Replace All: Replace your entire configuration with the imported one
- Merge: Add imported items alongside existing ones
- Select Items: Choose specific folders and specs to import
- Conflict Resolution: Automatically handles duplicate IDs and naming conflicts
⚙️ Configuration
Customize the extension to match your workflow:
{
"openapi-explorer.autoValidate": true,
"openapi-explorer.defaultLanguage": "typescript",
"openapi-explorer.showInlineHints": true,
"openapi-explorer.enableDiagnostics": true,
"openapi-enhanced.performance.enableCaching": true,
"openapi-enhanced.performance.enableMonitoring": true,
"openapi-enhanced.performance.cacheSize": 50
}
Available Settings
| Setting |
Default |
Description |
autoValidate |
true |
Automatically validate specs when opened |
defaultLanguage |
typescript |
Default language for code generation |
showInlineHints |
true |
Show inline hints and suggestions |
enableDiagnostics |
true |
Enable VS Code diagnostic messages |
enableCaching |
true |
Enable performance caching |
enableMonitoring |
true |
Show performance metrics in status bar |
🎯 Use Cases
👨💻 API Development
- Validate specifications during development
- Generate client SDKs and documentation
- Ensure consistency across teams
- Track API evolution over time
📚 Documentation & Review
- Browse complex APIs with ease
- Generate beautiful documentation
- Review API design decisions
- Share specifications with stakeholders
🧪 Testing & Integration
- Create realistic mock data
- Generate test scenarios
- Validate request/response examples
- Integration testing preparation
🔧 Maintenance & Optimization
- Identify deprecated endpoints
- Analyze API complexity metrics
- Optimize schema definitions
- Detect breaking changes
🛠️ Commands Reference
| Command |
Shortcut |
Description |
| Load Specification |
- |
Load OpenAPI spec from file or URL |
| Validate API Design |
- |
Run comprehensive validation checks |
| Generate Code Examples |
- |
Create multi-language code samples |
| Show Analytics |
- |
Display detailed API metrics |
| Open Enhanced View |
- |
Launch the advanced web interface |
| Export Documentation |
- |
Export in various formats |
| Search Endpoints |
Ctrl+Shift+F |
Find specific API endpoints |
| Filter by Method |
- |
Quick HTTP method filtering |
| Generate TypeScript Types |
- |
Create type definitions |
| Show Performance Report |
- |
View performance analytics |
🔗 Integration & Compatibility
Works seamlessly with your favorite tools:
- 🔌 REST Client: Use generated examples directly
- ⚡ Thunder Client: Import OpenAPI specs
- 📮 Postman: Export collections
- 🌐 Insomnia: Export workspace
- 📊 Git: Track API changes over time
- 🐳 Docker: Container-ready specifications
Supported File Types
- OpenAPI 3.0+ (JSON/YAML)
- Swagger 2.0 (JSON/YAML) - auto-converted
- Custom extensions:
.openapi.*, .swagger.*
| Specification Size |
Load Time |
Search Response |
Memory Usage |
| Small (< 50 endpoints) |
< 100ms |
< 10ms |
< 5MB |
| Medium (50-200 endpoints) |
< 300ms |
< 20ms |
< 15MB |
| Large (200-500 endpoints) |
< 800ms |
< 50ms |
< 30MB |
| Enterprise (500+ endpoints) |
< 2s |
< 100ms |
< 50MB |
Benchmarks performed on VS Code 1.84+ with 8GB RAM
🤝 Contributing
We welcome contributions from the community! Whether it's bug reports, feature requests, or code contributions, every bit helps make OpenAPI Spec Master better.
How to Contribute
- 🍴 Fork the repository
- 🌟 Create a feature branch
- ✨ Make your changes
- 🧪 Test thoroughly
- 📝 Submit a pull request
Development Setup
git clone https://github.com/RyanCardin15/Spec-Master.git
cd Spec-Master/extension
npm install
npm run compile
📈 Roadmap
- [ ] AI-Powered Suggestions: Smart API design recommendations
- [ ] Team Collaboration: Real-time spec sharing and commenting
- [ ] API Versioning: Visual diff and migration tools
- [ ] Custom Templates: User-defined code generation templates
- [ ] Cloud Integration: Direct integration with API gateways
- [ ] Security Scanner: Advanced security vulnerability detection
- 📖 Documentation - Comprehensive guides and tutorials
- 🐛 Issues - Report bugs and request features
- 💡 Discussions - Community Q&A and ideas
- 📧 Email - Direct support for enterprise users
📄 License
MIT License - see LICENSE for details.
🙏 Acknowledgments
Special thanks to:
- The OpenAPI Initiative for maintaining the specification
- The VS Code team for the excellent extension API
- Our community of contributors and users
Made with ❤️ by developers, for developers
Transform your API development experience today with OpenAPI Spec Master!
