API Sharing Introduction
AngusTester's sharing management feature supports one-click generation of API documentation links, securely sharing complete API specifications (including servers, authentication, request/response formats), ensuring consistent information across internal and external teams, reducing communication costs by 50%+.
Legend:
Supported features
❌ Unsupported features
Key Benefits
AngusTester's sharing management helps enterprises:
✅ Reduce integration communication time by 70%
✅ Decrease documentation transfer errors by 90%
✅ Improve partner satisfaction by 40%
✅ Ensure 100% compliant data sharing
Core Features
1. One-Click Sharing
- Shared Content:
- Complete API definition
- Request/response examples
- Authentication info (optional)
- Test cases (optional)
- Permission Control:
- Read-only/debug permissions
- Expiry settings (1 day/7 days/30 days/permanent)
- Generation Methods:
- Encrypted share links
- Downloadable PDF documents
- API integration format
2. Real-Time Collaboration & Updates
Collaboration Advantages:
- Automatic notifications for API changes
- Preserved version history
- Change comparison functionality
- One-click rollback to specific versions
API Sharing Field Reference
| Parameter | Field Name | Type | Required | Length Limit | Description |
|---|---|---|---|---|---|
| ID | id | bigint | Conditional | / | Unique identifier; Auto-generated; Mandatory for modifications |
| Share Name | name | string | Yes | ≤100 | Sharing configuration name |
| Description | remark | string | No | ≤400 | Sharing notes displayed on shared page |
| Expiry Date | expiredDate | datetime | No | / | Share link expiration time |
| Display Options | displayOptions | object | Yes | / | Shared page display configuration |
| Share Scope | shareScope | enum | Yes | / | Scope options: • SERVICES - Entire service• PARTIAL_APIS - Multiple APIs• SINGLE_APIS - Single API |
| Service ID | servicesId | long | Yes | / | Associated service ID |
| API ID Set | apisIds | set | Conditional | / | Required when shareScope is API-specific |
| Share Page URL | baseUrl | string | Yes | ≤2000 | Frontend sharing page base URL |
| Tenant ID | tenantId | long | Read-only | / | Tenant ID |
| Creator ID | createdBy | long | Read-only | / | Creator ID |
| Creator | createdBy Name | string | Read-only | / | Creator name |
| Creation Time | createdDate | datetime | Read-only | / | Creation timestamp |
| Last Editor ID | lastModified By | long | Read-only | / | Last editor ID |
| Last Editor | lastModified ByName | string | Read-only | / | Last editor name |
| Last Modified | lastModified Date | datetime | Read-only | / | Last modification timestamp |