api-validation-workflow

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

When to use:

• At the beginning of each development session
• After generating or modifying controllers
• Before implementing client/frontend code
• To understand existing API contracts

Usage workflow:

// 1. Ensure development server is running
await dev({ port: 3000, watch: true });

// 2. Fetch OpenAPI specification
const spec = await get_openapi_spec();

// 3. Analyze available endpoints
// 4. Plan tests based on specification
// 5. Store insights about the API

Knowledge storage:

• Always store significant API changes as api_mapping memories
• Document new endpoints and their responsibilities
• Relate endpoints to features and requirements

2.2 make_api_request Protocol

When to use:

• After implementing any endpoint
• To test success scenarios (happy path)
• To test error scenarios and edge cases
• To validate changes in existing endpoints
• During API problem debugging