Expand description
API Architecture Critique Engine
This module provides LLM-powered analysis of API schemas (OpenAPI, GraphQL, Protobuf) to detect anti-patterns, redundancies, naming issues, emotional tone problems, and provide restructuring recommendations.
§Features
- Anti-pattern Detection: REST violations, inconsistent naming, poor resource modeling
- Redundancy Detection: Duplicate endpoints, overlapping functionality
- Naming Quality Assessment: Inconsistent conventions, unclear names
- Emotional Tone Analysis: Error messages, user-facing text quality
- Restructuring Recommendations: Better resource hierarchy, consolidation opportunities
§Example Usage
ⓘ
use mockforge_core::ai_studio::api_critique::{ApiCritique, ApiCritiqueEngine, CritiqueRequest};
use mockforge_core::intelligent_behavior::IntelligentBehaviorConfig;
async fn example() -> mockforge_core::Result<()> {
let config = IntelligentBehaviorConfig::default();
let engine = ApiCritiqueEngine::new(config);
let request = CritiqueRequest {
schema: serde_json::json!({"openapi": "3.0.0"}),
schema_type: "openapi".to_string(),
focus_areas: vec!["anti-patterns".to_string(), "naming".to_string()],
};
let critique = engine.analyze(&request).await?;
Ok(())
}Structs§
- Anti
Pattern - Detected anti-pattern in API design
- ApiCritique
- API critique result
- ApiCritique
Engine - API Critique Engine
- Consolidation
Opportunity - Consolidation opportunity
- Critique
Request - Request for API critique analysis
- Hierarchy
Improvement - Hierarchy improvement suggestion
- Naming
Issue - Naming quality issue
- Redundancy
- Detected redundancy in API
- Resource
Modeling Suggestion - Resource modeling suggestion
- Restructuring
Recommendations - Restructuring recommendations
- Tone
Analysis - Emotional tone analysis
- Tone
Issue - Tone issue in API text