Skip to content

Service Management

The AngusTester Service Management supports full lifecycle management of API services for teams, covering core processes from service creation, import/export, test task management to quality verification.

I. Basic Service Operations

1. Add Service

Description: Create a new service framework
Steps:

  1. Navigate to Apis → Services
  2. Click the "Add Service" button above the service list
  3. Enter a unique service name (auto-saved)

⚠️ Note: Ensure service names are unique to avoid conflicts with existing services

2. Rename Service

Description: Modify service identification name
Steps:

  1. Right-click the target service in the list
  2. Select "Rename" option
  3. Enter new name (auto-saved)

3. Import Service

Description: Import external interface definition files
Steps:

  1. Right-click target service
  2. Select "Local Import" option
  3. Choose source type (OpenAPI/Postman/Angus)
  4. Upload file and configure import strategy
  5. View imported results in the right "Api List"

4. Export Service

Description: Export services for migration/backup
Steps:

  1. Right-click target service
  2. Select "Export Apis" option
  3. Choose export format and interface scope
  4. File automatically downloads after confirmation

5. Delete Service

Description: Remove unnecessary services
Steps:

  1. Right-click target service
  2. Select "Delete" option
  3. Confirm deletion

⚠️ Notes:

  • Deleted services can be recovered from Api Recycle Bin
  • Clearing recycle bin permanently deletes services and associated resources (except test tasks)

6. Clone Service

Description: Quickly duplicate services and interfaces
Steps:

  1. Right-click target service
  2. Select "Clone" option
  3. System automatically creates new service copy

7. Modify Status

Description: Update service lifecycle status
Supported Statuses: DesigningDevelopingDevelopment CompletePublished
Steps:

  1. Right-click target service
  2. Select "Modify Status" option
  3. Select new status and confirm

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

II. Modify Api Parameters

Description: Bulk modify configurations for all interfaces under a service
Supported Operations:

  • Add/Modify/Delete parameters
  • Enable/Disable parameters
  • Modify authentication configurations
  • Associate/Dissociate variables or datasets

Typical Scenario Steps:

  1. Bulk Modify Authentication Headers:
    • Select "Bulk Modify Authentication" option
    • Set authentication type as Bearer
    • Configure variable value {accessToken}
  2. Bulk Reference Variables:
    • Select "Bulk Reference Variables" option
    • Select target variables and confirm

III. Test Management

1. Generate Api Test Scripts

Prerequisite: Api debugging completed
Steps:

  1. Select "Api Test Scripts → Generate Test Scripts"
  2. Choose script type (Functional/Performance/Security etc.)
  3. Configure execution parameters
  4. View generated results in Scripts module

⚠️ Limitations:

  • Only one script allowed per test type
  • Must delete old script before regenerating

2. Delete Api Test Scripts

Description: Remove unnecessary test scripts
Steps:

  1. Select "Api Test Scripts → Delete Test Scripts"
  2. Check script types to delete
  3. Confirm deletion

⚠️ Note: Deleted scripts cannot be recovered

3. Bulk Enable/Disable Tests

Description: Unified management of interface test switches
Steps:

  1. Select "Enable/Disable Api Tests" option
  2. Set Enabled or Disabled status for each test type
  3. Confirm changes

4. Execute Service Smoke Tests

Description: Quickly verify basic interface functionality
Steps:

  1. Select "Execute Service Tests → Execute Smoke Tests"
  2. Configure Api Server (e.g., switch environment variables)
  3. System automatically generates/executes test scripts
  4. View test reports in Execution module

⚠️ Prerequisites:

  • Smoke test cases must be generated first
  • Only verifies basic functionality

5. Execute Service Security Tests

Description: Verify interface security controls
Steps:

  1. Select "Execute Service Tests → Execute Security Tests"
  2. Configure Api Server
  3. System automatically generates/executes test scripts
  4. View results in Execution module

⚠️ Prerequisite: Security test cases must be generated first

6. Execute Api Functional Tests

Description: Verify interface functionality meets expectations
Steps:

  1. Select "Execute Api Tests → Execute Functional Tests"
  2. Configure Api Server
  3. System automatically generates/executes test scripts
  4. View test reports in Execution module

7. Execute Api Stability Tests

Description: Verify interface stability under high load
Steps:

  1. Select "Execute Api Tests → Execute Stability Tests"
  2. Configure Api Server
  3. System automatically generates/executes test scripts
  4. View results in Execution module

8. Execute Api Performance Tests

Description: Test response time and throughput
Steps:

  1. Select "Execute Api Tests → Execute Performance Tests"
  2. Configure Api Server
  3. System automatically generates/executes test scripts
  4. View performance reports in Execution module

9. View Test Results

Steps:

  1. Open Test Results tab
  2. View interface test statistics

IV. Test Task Management

1. Generate Api Test Tasks

Description: Create interface test tasks for tracking
Steps:

  1. Select "Api Test Tasks → Generate Test Tasks"
  2. Fill in Iteration, Test Type, Assignee, Deadline
  3. View generated tasks in Tasks module

2. Reopen Api Test Tasks

Description: Reset task status to "Pending"
Steps:

  1. Select "Api Test Tasks → Reopen Test Tasks"
  2. System updates task status

⚠️ Notes:

  • Only applicable to Completed or Cancelled tasks
  • Task metrics are preserved

3. Restart Api Test Tasks

Description: Restart tasks and clear historical data
Steps:

  1. Select "Api Test Tasks → Restart Test Tasks"
  2. System resets task status and metrics

⚠️ Notes:

  • Only applicable to ended tasks
  • Task metrics are reset

4. Delete Api Test Tasks

Description: Remove unnecessary test tasks
Steps:

  1. Select "Api Test Tasks → Delete Test Tasks"
  2. Confirm deletion

V. Configuration Management

1. Edit Service Information

Description: Update basic service information
Steps:

  1. Click service name to open Service Info tab
  2. Click "Edit" button next to fields
  3. Save after modification

2. Edit Documentation

Description: Update OpenAPI documentation
Steps:

  1. Click service name to open Documentation tab
  2. Edit fields and save

Specification: OpenAPI Info Object

3. Api Sync Configuration

Description: Configure external API auto-sync
Steps:

  1. Open Sync Configuration tab
  2. Click "Edit" icon to modify settings
  3. Configure Sync URL, Sync Strategy etc.
  4. Save settings

⚠️ Limit: Maximum 10 sync configurations

4. Security Scheme Configuration

Description: Define unified authentication schemes
Steps:

  1. Open Security Scheme tab
  2. Configure security policies and authentication methods
  3. Save settings

Specification: OpenAPI Security Scheme

5. Server Configuration

Description: Manage API deployment environments
Steps:

  1. Open Server Configuration tab
  2. Click "Add Server"
  3. Configure URL, Description and Variables
  4. Use "Server Example" for quick template insertion

⚠️ Limit: Maximum 50 server configurations

V. Enterprise Integration

1. Mock Service Integration

Workflow:

  1. Service Details → Mock Configuration
  2. Choose creation method:
    • Generate new Mock service
    • Link existing Mock
  3. Complete configuration

Best Practice: Use Mock during development, switch to real environment for testing

2. Continuous Integration (TODO)


VI. Additional Features

1. View Activities

Description: Audit operation records
Steps:

  1. Open Activities tab
  2. View service/interface operation history

2. Request Proxy Configuration

Description: Configure personal request proxy to bypass CORS restrictions
Steps:

  1. Open Service Proxy tab
  2. Select proxy type
  3. Configure Proxy Service Address

⚠️ Scope: Only effective for current user

3. View Tags

Description: Manage interface classification tags
Steps:

  1. Open Tags tab
  2. View/manage tag categories

Specification: OpenAPI Tag Object

4. Edit Components

Description: Manage reusable object components
Steps:

  1. Open Components tab
  2. Edit component information

Specification: OpenAPI Components Object

Released under the GPL-3.0 License.