API Design Management

The API Design Management module in AngusTester enables full lifecycle management of OpenAPI specifications, supporting the entire workflow from design creation, import/editing to service generation.

I. Design Creation & Import

1. Create New Design

Description: Initialize OpenAPI specification framework
Steps:

1. API → Design Click "Add Design"
2. Fill in basic information:
   • Name (Format: [System]_API_Design_V1.0)
   • OpenAPI version (2.0/3.0.x)
3. Click "Save" to generate design draft

2. Import Existing Design

Description: Reuse external API specification files
Steps:

• File Import:
  1. Click "Import Design"
  2. Upload Swagger/OpenAPI file (JSON/YAML)
• Service Import:
  1. Click "Import Service"
  2. Select existing service to auto-generate design
     ❗ Verify specification completeness after import

II. Specification Design & Editing

1. Design API Specification

Description: Edit detailed OpenAPI definitions
Steps:

1. Design List Click "Design" on target item
2. Configure in editor:
   • Basic info (host/protocol/global parameters)
   • Path definitions (RESTful endpoints)
   • Component management (Schema/response templates)
3. Click "Save Draft" to temporarily store

2. Modify Design Content

Description: Update API definition details
Steps:

1. Design Editor Locate target node
2. Modify fields:
   • Add/delete endpoints
   • Adjust request parameters
   • Update response examples
     ⚠️ Major changes require new version

3. Clone Design Specification

Description: Quickly create iterative versions
Steps:

1. Design List Click "Clone"
2. Auto-generates:
   • Copy name (Original-Name-Copy)
   • Retains all specification definitions
     Requires manual version upgrade

III. Design Publishing & Service Generation

1. Publish Design Version

Description: Freeze design specification state
Steps:

1. Design Editor Click "Publish Design"
2. Fill in version change notes
3. Status changes to "Published"
   ❗ Direct modifications prohibited after publishing

2. Generate API Service

Description: Create executable API services
Steps:

1. Design List Select published design
2. Click "Generate Service"
3. System automatically:
   • Creates API service group
   • Generates all endpoints
   • Syncs parameter validation rules
     ✅ View in API → Services

3. Export Design Specification

Description: Share API design documentation
Steps:

1. Design List Click "Export"
2. Select format:
   • OpenAPI JSON
   • Swagger YAML

IV. Maintenance Operations

1. Design Version Upgrade (TODO)

Description: Manage multi-version API designs
Steps:

1. Design List Click historical version
2. Select "Upgrade Version"
3. Create new design copy
4. Modify and republish
   ❗ Maintain version compatibility

2. Delete Design

Description: Clean up obsolete API designs
Steps:

1. Design List Select target
2. Click "Delete"
3. Confirm operation
   ⚠️ Associated services unaffected