Skip to content

index.md

Latest commit

 

History

History
98 lines (74 loc) · 3.9 KB

index.md

File metadata and controls

98 lines (74 loc) · 3.9 KB

User Guide - Sentinel API Testing Platform

Welcome to the Sentinel User Guide! This comprehensive guide will help you get started with Sentinel and make the most of its powerful API testing capabilities.

📖 Table of Contents

  1. Quick Start Guide - Get up and running in minutes
  2. Managing API Specifications - Upload and manage your OpenAPI specs
  3. Running Your First Test - Step-by-step guide to your first test
  4. Understanding Test Types - Learn about different testing approaches
  5. Interpreting Test Results - Understand reports and analytics
  6. Using the Web Interface - Navigate the Sentinel UI
  7. CI/CD Integration - Integrate with your DevOps pipeline
  8. Command Line Interface - Use Sentinel from the terminal
  9. Role-Based Access Control - Manage users and permissions
  10. Advanced Features - Power user features

🎯 What is Sentinel?

Sentinel is an AI-powered API testing platform that automates comprehensive testing across multiple domains:

  • Functional Testing: Validate API behavior with positive, negative, and stateful tests
  • Security Testing: Detect vulnerabilities including BOLA, injection attacks, and authentication issues
  • Performance Testing: Conduct load, stress, and spike testing
  • Data Mocking: Generate realistic test data automatically

🚀 Key Benefits

For Developers

  • Automated test generation from OpenAPI specifications
  • Comprehensive coverage without manual test writing
  • Early detection of bugs and vulnerabilities
  • Integration with existing CI/CD pipelines

For QA Teams

  • Reduced manual testing effort
  • Consistent test execution
  • Detailed failure analysis and reporting
  • Historical trend analysis

For DevOps

  • Seamless CI/CD integration
  • Docker-based deployment
  • Scalable architecture
  • Comprehensive observability

🔄 Typical Workflow

  1. Upload Specification: Import your OpenAPI/Swagger specification
  2. Configure Testing: Select test types and parameters
  3. Execute Tests: Run tests manually or via CI/CD
  4. Analyze Results: Review detailed reports and insights
  5. Track Progress: Monitor trends and improvements over time

🎓 Learning Path

Beginners

  1. Start with the Quick Start Guide
  2. Learn to upload specifications
  3. Run your first test
  4. Understand test results

Intermediate Users

  1. Explore different test types
  2. Master the web interface
  3. Set up CI/CD integration

Advanced Users

  1. Use the CLI for automation
  2. Configure RBAC and permissions
  3. Leverage advanced features

💡 Tips for Success

  • Start Small: Begin with a simple API and expand gradually
  • Use Version Control: Track your API specifications in Git
  • Automate Early: Integrate with CI/CD from the beginning
  • Monitor Trends: Use analytics to track improvement over time
  • Collaborate: Share test results with your team

🔗 Related Documentation

📞 Getting Support

If you need help:

  1. Check the Troubleshooting Guide
  2. Search GitHub Issues
  3. Ask in the community forums
  4. Contact support (for enterprise users)

Ready to get started? Head to the Quick Start Guide →