API Reference
API Reference
Complete API documentation for Pack-Man
API Reference
The Pack-Man API is a RESTful interface that allows you to analyze software project dependencies. It supports multiple package managers (npm, pip, pub) and provides detailed information about dependency update status.
Key Features
- ✅ Dependency analysis from configuration files
- 🐙 GitHub repository integration with automatic file detection
- 🔍 Updated version checking against official registries
- 📊 Project summary statistics
- 🔗 Detailed package information (description, homepage)
- 🚀 Support for npm (package.json), pip (requirements.txt), and pub (pubspec.yaml)
- 🔐 GitHub token support for private repositories
Base URLs
- Development:
http://localhost:3000 - Production: [URL will be defined after deployment]
Authentication
Currently, the API does not require authentication. All endpoints are public and can be accessed directly.
Available Endpoints
Limits and Considerations
- Maximum file size: No specific limit, but files smaller than 1MB are recommended
- Rate limiting: Currently not implemented
- Timeout: Requests may take up to 30 seconds depending on the number of packages
- Cache: Version information is obtained in real-time from official registries