Documentation
¶
Overview ¶
Package swagger Code generated by swaggo/swag. DO NOT EDIT
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var SwaggerInfo = &swag.Spec{ Version: "0.7.0", Host: "localhost:8080", BasePath: "/api/v1", Schemes: []string{}, Title: "Scanorama API", Description: "Enterprise-grade network scanning and discovery service with automated reconnaissance capabilities\n\n## Features\n- **Advanced Scanning Engine**: Multiple scan types (connect, SYN, version, comprehensive, aggressive, stealth)\n- **Enterprise Reliability**: Race condition-free worker pools with graceful shutdown\n- **Database Integration**: PostgreSQL persistence with automatic migrations and transaction support\n- **Real-time Updates**: WebSocket support for live scan progress and results\n- **Comprehensive API**: RESTful endpoints with full CRUD operations\n- **Monitoring & Observability**: Built-in metrics, structured logging, and health checks\n- **Security**: Vulnerability scanning integration and secure error handling\n- **Scheduling**: Automated scan jobs with cron-like scheduling\n- **High Performance**: Concurrent processing with configurable rate limiting\n\n## Quality Assurance\n- **Test Coverage**: >90% coverage on core packages with comprehensive integration tests\n- **Security**: Zero known vulnerabilities with automated security scanning\n- **Code Quality**: Zero linting issues with automated quality checks\n\n## Authentication\nMost endpoints require API key authentication. Include your API key in the `X-API-Key` header.\nPublic endpoints (health, status, version, metrics) do not require authentication.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, LeftDelim: "{{", RightDelim: "}}", }
SwaggerInfo holds exported Swagger Info so clients can modify it
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.