Introduction to API Design
AngusTester's API design feature
provides a visual design environment compliant with OpenAPI standards. Through drag-and-drop editing and real-time validation, users can efficiently create standardized API documentation, improving team collaboration efficiency by 50%+.
Application Scenarios
- Agile Development: Rapid iteration of API design
- Microservices Architecture: Unified service interface standards
- API Productization: Create professional developer portals
- Team Collaboration: Real-time collaborative interface design
- Documentation as Code: Synchronous generation of design documents
Core Features
1. Visual API Specification Designer
- Drag-and-Drop Design: Intuitive creation of API paths, parameters, and responses
- Model Construction: Graphical definition of data structures and object relationships
- Real-Time Generation: Automatically generates YAML/JSON compliant with OpenAPI 3.0 specifications
- Enterprise Value: 60% improvement in design efficiency, 100% specification compliance
2. Real-Time OpenAPI Schema Validation
- Instant Feedback: Real-time syntax error checking during editing
- Specification Validation: Ensures compliance with OpenAPI 3.0 standards
- Error Localization: Precisely marks issue locations and provides repair suggestions
- Enterprise Value: 90% reduction in specification errors, improved documentation quality
3. Multi-Framework Integration Support
- Vue Integration: Provides dedicated component libraries for seamless embedding in Vue projects
- React Support: Out-of-the-box React Hooks and components
- Vanilla JS: Pure JavaScript API for flexible integration
- Enterprise Value: 70% reduction in integration costs, adaptable to existing tech stacks
4. Dynamic API Documentation Preview
- Instant Rendering: Design changes reflected in documentation in real time
- Multi-Format Preview: Instant viewing in HTML/PDF
- Interactive Documentation: Supports "Debug" functionality for interface testing
- Enterprise Value: 75% reduction in documentation delivery time
API Design Field Information
| Parameter | Field Name | Type | Required | Length Limit | Description |
|---|---|---|---|---|---|
| ID | id | bigint | Conditional | / | Unique identifier; Automatically generated by the system; Required for modifications |
| Project ID | projectId | long | Yes | / | Associated project ID |
| Design Name | name | string | Yes | ≤100 | API design name |
| Release Status | released | boolean | No | / | Whether it has been released |
| OpenAPI Version | openapiSpec Version | string | Yes | / | Supported Versions: • 3.0.0 • 3.0.1 • 3.0.2 • 3.0.3 • 3.1.0 |
| OpenAPI Specification | openapi | string | No | / | OpenAPI specification content |
| Design Source | designSource | enum | No | / | Sources: • SYNCHRONOUS_SERVICE - Synchronous service• FILE_IMPORT - File import• MANUAL_CREATED - Manual creation |
| Source ID | designSource Id | long | No | / | Source object ID |
| Source Name | designSource Name | string | Read-only | / | Source object name |
| 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 time |
| Last Modified By ID | lastModified By | long | Read-only | / | Last modifier ID |
| Last Modified By | lastModified ByName | string | Read-only | / | Last modifier name |
| Last Modified Time | lastModified Date | datetime | Read-only | / | Last modification time |