API Management

The AngusTester API Management feature supports end-to-end API lifecycle management, enabling efficient collaboration from creation and testing to documentation, thereby improving API development and testing efficiency.

I. Basic API Operations

1. Add HTTP API

Description: Create standard HTTP protocol APIs
Steps:

1. Navigate to API → Services
2. Click the "Add HTTP API" button
3. Configure request method, path, and parameters
4. Click "Send Request" to test the API
5. Click "Archive" to save the API

⚠️ Debugging Tip: Ensure parameters are correctly configured before sending requests

2. Add WebSocket API

Description: Create WebSocket protocol APIs
Steps:

1. Navigate to API → Services
2. Click the "Add WebSocket API" button
3. Configure path and parameters
4. Click "Archive" to save the API

3. Add Unarchived API

Description: Create temporary debugging APIs (visible only to the creator)
Steps:

1. Navigate to API → Services
2. Click the "Add HTTP API" button
3. Configure request parameters
4. Click "Save as Unarchived"

II. API Management Operations

1. Edit API

Description: Modify API configuration parameters
Steps:

1. Double-click the target API
2. Modify request configurations
3. Click "Save"

2. Clone API

Description: Quickly duplicate API configurations
Steps:

1. Select the target API
2. Click the "Clone" button
3. Modify the new API configuration
4. Click "Save"

3. Move API

Description: Transfer an API to another service
Steps:

1. Select the target API
2. Click the "Move" button
3. Choose the target service
4. Confirm the move

4. Export API

Description: Export API definitions for backup or sharing
Steps:

1. Select the target API
2. Click the "Export" button
3. The file will automatically download locally

5. Update API Status

Description: Update the development status of an API
Supported Statuses:

• Designing
• Developing
• Development Completed
• Published

Steps:

1. Select the target API
2. Click "Update Status"
3. Select the new status

⚠️ Permission Requirement: "Publish" permission is required to set status as Published

6. Follow API

Description: Subscribe to an API for change notifications
Steps:

1. Select the target API
2. Click the "Follow" button

⚠️ Notification Mechanism: Followed APIs will trigger notifications upon changes

7. Favorite API

Description: Add an API to the quick-access list
Steps:

1. Select the target API
2. Click the "Favorite" button

III. API Testing Management

1. Generate Test Script

Description: Create automated test scripts
Steps:

1. Select the target API
2. Click "Test Script → Generate Test Script"
3. Select the test type
4. Configure execution parameters

⚠️ Limitations:

• Only one script per test type is allowed
• Existing scripts must be deleted before regeneration

2. Execute Functional Test

Description: Validate API business logic correctness
Steps:

1. Select the target API
2. Click "Execute Test → Execute Functional Test"
3. Configure server environment
4. View results in the Execution module

3. Execute Stability Test

Description: Validate API stability under high load
Steps:

1. Select the target API
2. Click "Execute Test → Execute Stability Test"
3. Configure server environment
4. View results in the Execution module

4. Execute Performance Test

Description: Test API throughput and response time
Steps:

1. Select the target API
2. Click "Execute Test → Execute Performance Test"
3. Configure server environment
4. View results in the Execution module

5. Manage Test Cases

Description: Comprehensive test case management
Supported Operations:

• Add case (Click "Add" to configure parameters)
• Edit case (Click "Edit" to modify configurations)
• Clone case (Click "Clone" to create a copy)
• Delete case (Click "Delete" to remove)
• Execute case (Click "Execute Test" to validate functionality)

⚠️ Parameter Configuration: Variables/datasets must be pre-declared

IV. API Documentation

1. Generate Mock API

Description: Create simulated API versions
Steps:

1. Select the target API
2. Click "Mock API → Generate Mock API"
3. Select Mock service
4. Enter API name

2. Associate Mock API

Description: Bind existing mock services
Steps:

1. Select the target API
2. Click "Mock API → Associate Mock API"
3. Select the service to associate
4. Confirm association

3. Generate Client Code

Description: Obtain multi-language calling examples
Steps:

1. Select the target API
2. Open the "Code" tab
3. Select programming language
4. Copy the generated calling code

V. Test Task Management

1. Generate Test Task

Description: Create API testing tracking tasks
Steps:

1. Select the target API
2. Click "Test Task → Generate Test Task"
3. Fill in iteration/assignee/deadline
4. Track the task in the Tasks module

2. Manage Test Tasks

Description: Comprehensive test task status management
Supported Operations:

Operation Type	Description	Notes
Reopen	Reset to pending status	Retains original task metrics
Restart	Reset to pending status	Clears task metrics
Delete	Remove task	Irreversible

⚠️ Status Restriction: Only applicable to Completed/Canceled tasks

VI. Other Features

1. Configure Request Proxy

Description: Set up cross-origin request proxies
Steps:

1. Select the target API
2. Open "Proxy" settings
3. Select proxy type

⚠️ Scope: Only applies to the current user

2. View Test Results

Description: Check API test execution status
Steps:

1. Select the target API
2. Open the "Test Results" tab

3. View Activity Log

Description: Audit API operation history
Steps:

1. Select the target API
2. Open the "Activity" tab