Skip to content

API Sharing Management

The API Sharing Management module in AngusTester provides a convenient mechanism for sharing API documentation, supporting the creation of configurable access links for API documents.

I. Share Creation Management

1. Create API Share

Description: Generate shareable API documentation links
Steps:

  1. API → Share Click "Add Share"
  2. Configure sharing parameters:
    • Share name (e.g., OrderAPI_V1.0_Share)
    • Expiration date (default: permanent)
    • Display options (hide sensitive fields/collapse parameters)
    • API scope (select all/custom selection)
    • Configure display options:
      • Example count style
      • Disable debugging
      • Enable watermark (with visitor info)
  3. Click "Confirm" to generate share

II. Share Information Management

1. Modify Share Configuration

Description: Update validity period or display parameters
Steps:

  1. Share List Click "Edit" on target share
  2. Adjustable items:
    • Extend/shorten validity
    • Add/remove APIs
    • Toggle display options
  3. Click "Confirm" to save

2. Copy Share Information

Description: Quickly obtain share link
Steps:

  1. Share List Click "Copy" icon
  2. System automatically:
    • Copies access link to clipboard

III. Share Access Control

1. Force Share Expiration

Description: Terminate share validity in advance
Steps:

  1. Share List Select target share
  2. Click "Delete" action
  3. Confirm operation
    ❗ All access becomes invalid immediately after deletion

2. Access Log Review (TODO)

Description: Monitor share link usage
Steps:

  1. Share Details View:
    • Recent access IP/time
    • Document view count
    • Abnormal access alerts
      90-day access record retention

Released under the GPL-3.0 License.