Skip to content

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

  1. Agile Development: Rapid iteration of API design
  2. Microservices Architecture: Unified service interface standards
  3. API Productization: Create professional developer portals
  4. Team Collaboration: Real-time collaborative interface design
  5. 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

View Open Source Components

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

ParameterField NameTypeRequiredLength LimitDescription
IDidbigintConditional/Unique identifier;
Automatically generated by the system;
Required for modifications
Project IDprojectIdlongYes/Associated project ID
Design NamenamestringYes≤100API design name
Release StatusreleasedbooleanNo/Whether it has been released
OpenAPI VersionopenapiSpec
Version
stringYes/Supported Versions:
• 3.0.0
• 3.0.1
• 3.0.2
• 3.0.3
• 3.1.0
OpenAPI SpecificationopenapistringNo/OpenAPI specification content
Design SourcedesignSourceenumNo/Sources:
SYNCHRONOUS_SERVICE - Synchronous service
FILE_IMPORT - File import
MANUAL_CREATED - Manual creation
Source IDdesignSource
Id
longNo/Source object ID
Source NamedesignSource
Name
stringRead-only/Source object name
Tenant IDtenantIdlongRead-only/Tenant ID
Creator IDcreatedBylongRead-only/Creator ID
CreatorcreatedBy
Name
stringRead-only/Creator name
Creation TimecreatedDatedatetimeRead-only/Creation time
Last Modified By IDlastModified
By
longRead-only/Last modifier ID
Last Modified BylastModified
ByName
stringRead-only/Last modifier name
Last Modified TimelastModified
Date
datetimeRead-only/Last modification time

Released under the GPL-3.0 License.