How naveeth235/apiguard works
APIGuard is a CLI for provider-side contract verification: it loads JSON contracts, sends real HTTP requests to a running provider, validates response status and body shape, and produces console or HTML results. Failed contracts can optionally receive AI explanations; deterministic validation remains authoritative. The repository also includes an e-commerce demo spanning customer profiles, catalog, inventory, and orders. The graph preserves these product branches. Some runner, loader, reporting, and analysis relationships are inferred from the documented workflow rather than sampled implementation, so those edges are dashed and uncited.
Main entry points: ContractRunner.java Contract Runner · APIGuardRunner.java APIGuard Runner · TestExecutor.java HTTP Executor · ResponseValidator.java Response Validator
Components 22
Contract Verification
- JSON Contracts
src/main/java/apiguard/contract/Contract.java - Request Schema
src/main/java/apiguard/contract/Request.java - Contract Loader
src/main/java/apiguard/loader/ContractLoader.java - APIGuard Runner
src/main/java/apiguard/runner/APIGuardRunner.java - Contract Runner
src/main/java/apiguard/runner/ContractRunner.java - HTTP Executor
src/main/java/apiguard/executor/TestExecutor.java
Validation And Reports
- Response Validator
src/main/java/apiguard/validator/ResponseValidator.java - Failure Analysis
src/main/java/apiguard/analysis/FailureAnalyzer.java - Test Reports
src/main/java/apiguard/report/TestSuiteReport.java - HTML Report
src/main/java/apiguard/report/HtmlReportGenerator.java
Optional AI Analysis
- Failure Context
src/main/java/apiguard/ai/FailureContextBuilder.java - AI Analysis
src/main/java/apiguard/ai/AIAnalysisService.java - Ollama Provider
src/main/java/apiguard/ai/OllamaAIAnalysisService.java - Mock Provider
src/main/java/apiguard/ai/MockAIAnalysisService.java
Commerce Demo
- Product Catalog
catalog-service/src/main/java/com/apiguard/catalogservice/service/CatalogService.java - Inventory
inventory-service/src/main/java/com/apiguard/inventoryservice/service/InventoryService.java - Order Processing
order-service/src/main/java/com/apiguard/orderservice/service/OrderService.java
Identity Demo
- Customer Profiles
user-service/src/main/java/com/apiguard/userservice/service/UserProfileService.java - Provider Users
provider-service/src/main/java/com/apiguard/provider/service/UserService.java
Other components
- CLI User
- Running Provider
- Ollama Service
Connections 22
- CLI User → APIGuard Runner: starts CLI
- APIGuard Runner → Contract Loader: loads contracts
- Contract Loader → JSON Contracts: reads JSON
- JSON Contracts → Request Schema: defines request
src/main/java/apiguard/contract/Contract.java - APIGuard Runner → Contract Runner: runs suite
- Contract Runner → HTTP Executor: sends requests
- HTTP Executor → Running Provider: HTTP requests
README.md - HTTP Executor → Response Validator: validates response
- Response Validator → JSON Contracts: checks expectations
src/main/java/apiguard/validator/ResponseValidator.java - Response Validator → Failure Analysis: classifies failures
src/main/java/apiguard/validator/ResponseValidator.java - Contract Runner → Test Reports: collects results
- Test Reports → HTML Report: renders HTML
- Contract Runner → Failure Context: builds failure context
- Failure Context → AI Analysis: requests explanation
- AI Analysis → Ollama Provider: selects provider
README.md - AI Analysis → Mock Provider: selects provider
README.md - Ollama Provider → Ollama Service: sends analysis request
src/main/java/apiguard/ai/OllamaAIAnalysisService.java - Customer Profiles → Customer Profiles: serves profile data
README.md - Provider Users → Provider Users: manages users
provider-service/src/main/java/com/apiguard/provider/service/UserService.java - Product Catalog → Product Catalog: serves product data
catalog-service/src/main/java/com/apiguard/catalogservice/service/CatalogService.java - Order Processing → Product Catalog: fetches products
order-service/src/main/java/com/apiguard/orderservice/service/OrderService.java - Order Processing → Inventory: reserves stock
order-service/src/main/java/com/apiguard/orderservice/service/OrderService.java