testing

API Validation Workflow Integration

This rule defines how API validation tools (get_openapi_spec and make_api_request) should be integrated into the development workflow to enable autonomous testing and continuous validation of implemented features.

1. Development Cycle Integration

1.1 Workflow Phases with API Validation

graph TB
    A[Requirements Gathering] --> B[Planning]
    B --> C[Waiting Approval]
    C --> D[Work Phase]
    D --> E{Validation Phase}
    E --> F[API Testing]
    F --> G{Tests Pass?}
    G -->|Yes| H[Revise & Document]
    G -->|No| I[Debug & Fix]
    I --> F
    H --> J[Feedback]
    J --> K[Learn & Improve]

    style F fill:#e1f5fe
    style G fill:#fff3e0

1.2 Mandatory Integration Points

During Work Phase:

• After implementing each endpoint
• After modifying API data structures
• Before marking tasks as complete

During Validation Phase:

• Complete validation of implemented feature
• Testing success and error scenarios
• API contract validation

During Revise Phase:

• Re-testing after fixes
• Regression validation

2. Tool Usage Protocols

2.1 get_openapi_spec Protocol - MANDATORY FIRST STEP

🚨 CRITICAL REQUIREMENT: This is the FIRST STEP for ALL testing scenarios

When to use:

• MANDATORY: At the beginning of EVERY testing session
• MANDATORY: Before ANY API request testing
• MANDATORY: To verify if application is online and accessible
• After generating or modifying controllers
• Before implementing client/frontend code
• To understand existing API contracts

CRITICAL VALIDATION WORKFLOW:

// 1. FIRST: Investigate the default server port and check if it's already running.
//    If the server is not running, only then proceed to start it.
// 2. ONLY THEN proceed with other testing.
// 3. Store insights about the API.

Server Startup Protocol:

• If get_openapi_spec fails after initial investigation: Automatically start development server.
• Wait for server initialization: Allow 2-3 seconds for server to be ready.
• Retry validation: Confirm server is accessible before proceeding.
• Document server status: Store server startup patterns for future reference.