API Testing

API Test Example

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
class ProductApiTest {

    @Test
    void shouldGetProductById() throws Exception {
        mockMvc.perform(get("/api/products/1"))
            .andExpect(status().isOk())
            .andExpect(jsonPath("$.name").value("Laptop"))
            .andExpect(jsonPath("$.price").value(999.99));
    }

    @Test
    void shouldReturn404WhenProductNotFound() throws Exception {
        mockMvc.perform(get("/api/products/999"))
            .andExpect(status().isNotFound());
    }
}

Design Principles

• Use nouns, not verbs
• Plural resource names
• Consistent naming conventions
• Proper HTTP status codes

Versioning

• URI versioning (/v1/resource)
• Header versioning
• Deprecation policy

Documentation

• OpenAPI/Swagger specs
• Request/Response examples
• Error code documentation
• Rate limit documentation

Key Points

• Understanding API Testing is essential for production systems
• Always consider scalability and maintainability
• Test thoroughly before deploying to production
• Monitor performance and set up alerting

Common Patterns

1. Validation: Always validate input at the boundary
2. Error Handling: Use structured error responses
3. Logging: Log key events for debugging
4. Testing: Unit, integration, and load tests
5. Documentation: Keep docs updated with code changes