| name | automating-api-testing |
| description | This skill automates API endpoint testing, including request generation, validation, and comprehensive test coverage for REST and GraphQL APIs. It is used when the user requests API testing, contract testing, or validation against OpenAPI specifications. The skill analyzes API endpoints and generates test suites covering CRUD operations, authentication flows, and security aspects. It also validates response status codes, headers, and body structure. Use this skill when the user mentions "API testing", "REST API tests", "GraphQL API tests", "contract tests", or "OpenAPI validation".
|
| allowed-tools | Read, Write, Edit, Grep, Glob, Bash |
| version | 1.0.0 |
Overview
This skill empowers Claude to automatically generate and execute comprehensive API tests for REST and GraphQL endpoints. It ensures thorough validation, covers various authentication methods, and performs contract testing against OpenAPI specifications.
How It Works
- Analyze API Definition: The skill parses the provided API definition (e.g., OpenAPI/Swagger file, code files) or infers it from usage.
- Generate Test Cases: Based on the API definition, it creates test cases covering different scenarios, including CRUD operations, authentication, and error handling.
- Execute Tests and Validate Responses: The skill executes the generated tests and validates the responses against expected status codes, headers, and body structures.
When to Use This Skill
This skill activates when you need to:
- Generate comprehensive API tests for REST endpoints.
- Create GraphQL API tests covering queries, mutations, and subscriptions.
- Validate API contracts against OpenAPI/Swagger specifications.
- Test API authentication flows, including login, refresh, and protected endpoints.
Examples
Example 1: Generating REST API Tests
User request: "Generate API tests for the user management endpoints in src/routes/users.js"
The skill will:
- Analyze the user management endpoints in the specified file.
- Generate a test suite covering CRUD operations (create, read, update, delete) for user resources.
Example 2: Creating GraphQL API Tests
User request: "Create GraphQL API tests for the product queries and mutations"
The skill will:
- Analyze the product queries and mutations in the GraphQL schema.
- Generate tests to verify the functionality and data integrity of these operations.
Best Practices
- API Definition: Provide a clear and accurate API definition (e.g., OpenAPI/Swagger file) for optimal test generation.
- Authentication Details: Specify the authentication method and credentials required to access the API endpoints.
- Contextual Information: Provide context about the API's purpose and usage to guide the test generation process.
Integration
This skill can integrate with other plugins to retrieve API definitions from various sources, such as code repositories or API gateways. It can also be combined with reporting tools to generate detailed test reports and dashboards.
