API Introduction

AngusTester's API module empowers developers and testers to efficiently manage test APIs, supporting online editing, debugging, and comprehensive testing. It helps enterprises achieve API assetization, improve delivery quality and performance, while significantly increasing efficiency and reducing costs.

About APIs

As core deliverables and capability assets in software development, the quality and performance of APIs greatly impact user experience. Through the API module, you can:

• ✅ API Development & Debugging: Provides online editing and real-time debugging to quickly create and validate APIs.
• ✅ API Management: Supports centralized API management, including categorization, version control, and documentation, enhancing team collaboration efficiency.
• ✅ API Testing: Offers functional testing, parameterized testing, performance testing, and stability testing to comprehensively validate API quality.
• ✅ API Design: Features a graphical interface based on OpenAPI specifications, improving API design efficiency by 60% and reducing documentation maintenance costs by 45%.
• ✅ Test Task Management: Supports creating, assigning, and tracking test tasks to ensure thorough API testing.
• ✅ Test Result Analysis: Automatically generates test reports with data visualization, helping teams analyze results and performance metrics.

Core Advantages

Advantage	Description	User Benefits
Standardization Support	OpenAPI specification compatibility	Seamless integration with existing API development ecosystems
Automated Documentation	Synchronized design and documentation	Reduces documentation maintenance costs by 50%+
Enhanced Collaboration	Document sharing and permission control	Improves team collaboration efficiency by 40%
Visual Design	Graphical API design	Lowers the barrier to API design
Quality Visibility	Quantified and visualized quality metrics	Access API quality reports anytime

Application Scenarios

• API Design: Use graphical tools to create OpenAPI-compliant interfaces.
• Microservices Development: Ensure service contracts align with implementations.
• Documentation Portal: Generate professional developer portal websites.
• Team Collaboration: Unified management of API design and documentation.
• Comprehensive Testing: Conduct various API testing activities.

Experience AngusTester's API Features Now →

Core Features

1. API Development & Debugging

• Visual Editing: Intuitive interface for configuring API parameters.
• Instant Debugging: View response data in real time to quickly validate API logic.
• Server Configuration: Multi-environment switching (Dev/Test/Prod).

2. Documentation & Sharing Support

• Auto-generated Documentation: Standardized documentation generated automatically after API configuration.
• Version Control: Documentation updates synchronously with API versions.
• Multi-format Sharing: Export to HTML/PDF/Markdown formats.
• Team Collaboration: Set document access permissions for real-time collaborative editing.

3. OpenAPI Graphical Design

• Visual Designer: Drag-and-drop creation and modification of OpenAPI specifications.
• Bidirectional Compatibility: Seamless import/export of OpenAPI 3.0+ specification files.
• Spec Validation: Real-time checks for OpenAPI specification completeness.
• Document Synchronization: Design changes automatically update API documentation.

4. Comprehensive Testing Capabilities

• Functional Validation: Test API behavior under various input conditions.
• Performance Testing: Simulate high-concurrency scenarios to identify bottlenecks.
• Stability Testing: Long-running tests to verify system reliability.
• Custom Testing: Address other business-specific testing needs.

5. Automated Test Analysis

• Smart Reports: Automatically generate test reports with key metrics.
• Data Insights: Visualize performance trends and bottlenecks.
• Issue Localization: Accurately pinpoint root causes of API issues.

API Field Information

Parameter	Field Name	Type	Required	Length Limit	Description
API ID	id	long	Conditional	/	Unique identifier for the API (required for modifications)
Service ID	serviceId	long	Yes	/	ID of the associated service
Protocol Type	protocol	enum	Yes	/	Protocol Enum: • http • https • ws • wss
Request Method	method	enum	Yes	/	Method Enum: • GET • HEAD • POST • PUT • PATCH • DELETE • OPTIONS • TRACE
Endpoint Path	endpoint	string	Yes	≤800	API path (excluding query parameters), e.g., /api/v1/users/{id}
API Name	summary	string	Yes	/	API summary or name
API Description	description	string	No	≤20000	Detailed description (supports CommonMark rich text)
Tags	tags	list	No	/	OpenAPI tag list
Operation ID	operationId	string	No	≤400	OpenAPI operation identifier
External Docs	externalDocs	object	No	/	Associated external documentation
Request Parameters	parameters	list	No	≤100	List of request parameters
Request Body	requestBody	object	No	/	Request body definition
Response Definitions	responses	map	No	/	Collection of response definitions
Deprecation Status	deprecated	boolean	No	/	Whether deprecated (default: false)
Security Requirements	security	list	No	/	List of security requirements
Extension Properties	extensions	map	No	/	OpenAPI extension fields
Authentication Scheme	authentication	object	No	/	Security authentication scheme
Assertion Configuration	assertions	list	No	≤100	Assertions for API execution results
API Status	status	enum	Yes	/	Status Enum: • UNKNOWN - Unknown • IN_DESIGN - In Design • IN_DEV - In Development • DEV_COMPLETED - Development Completed • RELEASED - Released
Owner ID	ownerId	long	Yes	/	API owner ID
Owner	ownerName	string	No	/	Owner name
Authorization Control	auth	boolean	No	/	Whether authorization control is enabled
Service Authorization	serviceAuth	boolean	Read-only	/	Whether inheriting service-level authorization
Security Flag	secured	boolean	No	/	Whether security mechanisms are enabled
Functional Testing	testFunc	boolean	No	/	Whether functional testing is enabled (default: true)
Functional Test Passed	testFunc Passed	boolean	Read-only	/	Whether functional testing passed
Functional Test Failure Reason	testFunc FailureMessage	string	Read-only	/	Reason for functional test failure
Performance Testing	testPerf	boolean	No	/	Whether performance testing is enabled (default: true)
Performance Test Passed	testPerf Passed	boolean	Read-only	/	Whether performance testing passed
Performance Test Failure Reason	testPerf FailureMessage	string	Read-only	/	Reason for performance test failure
Stability Testing	testStability	boolean	No	/	Whether stability testing is enabled (default: true)
Stability Test Passed	testStability Passed	boolean	Read-only	/	Whether stability testing passed
Stability Test Failure Reason	testStability FailureMessage	string	Read-only	/	Reason for stability test failure
Dataset End Policy	datasetAction OnEOF	enum	No	/	Dataset end-of-file policy (default: RECYCLE)
Dataset Sharing Mode	datasetSharing Mode	enum	No	/	Multi-thread dataset sharing mode (default: ALL_THREAD)
Available Servers	availableServers	list	No	/	List of available servers
Tag Models	tagSchemas	map	No	/	Tag model definitions
Favorite Status	favourite	boolean	No	/	Whether favorited
Follow Status	follow	boolean	No	/	Whether followed
Sync Name	syncName	string	Read-only	/	Sync configuration name
Resolved Reference Models	resolvedRef Models	map	Read-only	/	Resolved reference models
Tenant ID	tenantId	long	Read-only	/	Tenant ID
Creator	createdBy Name	string	Read-only	/	Creator name
Creation Time	createdDate	datetime	Read-only	/	Creation time
Last Modified By	lastModified ByName	string	Read-only	/	Last modifier name
Last Modified Time	lastModified Date	datetime	Read-only	/	Last modification time

API Status Flow

Key Field Descriptions

1. Design Phase:

• Set status="In Design"
• Complete summary and description
• Define parameters and requestBody
• Assign ownerId to clarify responsibility

2. Development Phase:

• Update status="In Development"
• Configure assertions to validate logic

3. Testing Phase:

• Enable testFunc/testPerf/testStability
• Validate API functionality and performance
• Update status="Development Completed"

4. Release Phase:

• Set status="Released"
• Configure auth security policies
• Add tags for easy retrieval and management

5. Maintenance Phase:

• Track changes via lastModified* fields
• Mark deprecated APIs with deprecated
• Regularly review API status

OpenAPI Specification Extensions

AngusTester extends OpenAPI specification fields to provide more flexible API configuration capabilities, enabling fine-grained control over API behavior.

General Configuration Fields

• x-xc-id: Unique identifier for APIs or resources
• x-xc-value: Parameter/configuration storage value
• x-xc-type: Data type definition
• x-xc-status: Current status of the resource/API
• x-xc-enabled: Feature toggle (true=enabled, false=disabled)
• x-xc-projectId: Associated project ID
• x-xc-projectName: Associated project name

Request Configuration Fields

• x-xc-url: Target request URL (supports internal/external addresses)
• x-xc-isFile: File upload flag (true=file request)
• x-xc-fileName: Uploaded file name (effective when x-xc-isFile=true)
• x-xc-requestId: Unique request ID (for tracking/debugging)
• x-xc-serverSource: Request source server identifier (environment differentiation)
• x-xc-messageMode: Transmission mode (sync=synchronous, async=asynchronous)
• x-xc-requestSetting: Request settings (timeout/retry policies, etc.)

Content Format Fields

• x-xc-contentType: Content type (e.g., application/json)
• x-xc-contentEncoding: Content encoding (e.g., gzip)
• x-xc-wsMessage: WebSocket message body content

Security Authentication Fields

• x-xc-apiKey: API key (for authentication)
• x-xc-oauth2-authFlow: OAuth2 flow type (authorization_code, etc.)
• x-xc-oauth2-token: OAuth2 access token
• x-xc-oauth2-clientId: Client ID
• x-xc-oauth2-clientSecret: Client secret
• x-xc-oauth2-newToken: Whether to fetch a new token (true=force refresh)
• x-xc-oauth2-in: Token passing location (request header/query parameter)
• x-xc-oauth2-callbackUrl: Authentication callback URL
• x-xc-oauth2-username: Username (password mode)
• x-xc-oauth2-password: Password credential (password mode)
• x-xc-oauth-extensionName: OAuth2 extension identifier

Relationship Fields

• x-xc-apisId: Unique identifier for associated APIs
• x-xc-serviceId: Unique identifier for associated services