API Testing (Chinese Version)

api-testing-en

prompts/api-testing.md

When to Use

• User mentions "API testing" or "api-testing"
• Need to execute such tests or produce corresponding deliverables based on Standard-version
• Trigger Example: "Generate/design/write... based on the following content"

Output Format Options

How to Use

1. Open

   prompts/api-testing.md

   in this directory, copy the content below the dashed line to the AI conversation.
2. Attach your specific requirements.
3. If you need Excel/CSV/JSON, add the request sentence from output-formats.md at the end.

Code Examples

1. Postman + Newman REST API Testing

examples/postman-rest-api/

• Postman collection file (10 test cases)
• Environment variable configuration
• Newman automation run script
• Detailed README documentation

cd examples/postman-rest-api
npm install -g newman
./newman-run.sh

• User CRUD operations (Create, Read, Update, Delete)
• Authentication and authorization testing
• Error handling and boundary conditions
• Response time verification
• Data format validation

Best Practices

API Testing Design Principles

1. Test Pyramid
   • Unit testing: Test individual API endpoints
   • Integration testing: Test interactions between multiple endpoints
   • End-to-end testing: Test complete business processes
2. Test Data Management
   • Use environment variables to manage configurations for different environments
   • Use dynamic variables to avoid hardcoding
   • Clean up data after testing
3. Assertion Strategy
   • Verify status codes
   • Verify response structure (Schema Validation)
   • Verify response data
   • Verify response time
4. Error Handling
   • Test various error scenarios (4xx, 5xx)
   • Verify error message format
   • Test boundary conditions

Tool Selection Recommendations

Troubleshooting

Common Issues

1. Newman Run Failed

newman: command not found

# Install Newman globally
npm install -g newman

# Or use npx (no global installation required)
npx newman run collection.json

2. Environment Variables Not Taking Effect

{{variable}}

• Ensure the

  -e

  parameter is used to specify the environment file
• Check if variable names in the environment file are correct
• Verify variable settings in Postman

newman run collection.json -e environment.json

3. Certificate Verification Error

SSL certificate problem

# Temporarily disable SSL verification in development environments (not recommended for production)
newman run collection.json --insecure

# Or specify CA certificate
newman run collection.json --ssl-client-cert-list cert-list.json

4. Request Timeout

Error: ETIMEDOUT

Error: ESOCKETTIMEDOUT

# Increase timeout (in milliseconds)
newman run collection.json --timeout-request 30000

# Add request delay
newman run collection.json --delay-request 500

5. Response Data Format Mismatch

• Use Postman's Schema generation feature
• Check API documentation to confirm data structure
• Use

  pm.response.json()

  to print the actual response

// Add debugging information in Tests
console.log(pm.response.json());

6. Dynamic Data Dependency Issue

// Save data in Tests of the first request
pm.environment.set("userId", pm.response.json().id);

// Use it in subsequent requests
// URL: {{baseUrl}}/users/{{userId}}

7. Batch Test Run Failed

• Check data dependencies between tests
• Ensure each test can run independently
• Add appropriate delay:

  --delay-request 200

• Use

  --bail

  to stop on first failure

Reference Files

• prompts/api-testing.md — Standard-version prompts for API testing
• output-formats.md — Instructions for requesting Markdown / Excel / CSV / JSON output
• examples/postman-rest-api/ — Complete Postman + Newman example
• quick-start.md — 5-minute quick start guide