๐๏ธ Overview
Overview of the Kolibrium API module โ a KSP-based code generation tool for type-safe HTTP clients with automatic serialization, authentication, and testing utilities
๐๏ธ Defining API Specification
Define API specifications in Kolibrium using the @GenerateApi annotation and ApiSpec base class, including converting from OpenAPI specs
๐๏ธ Request Models
Define request models in Kolibrium API with path, query, header, and body parameters for type-safe HTTP endpoint definitions
๐๏ธ Response Models and Return Types
Define response models and return types in Kolibrium API including typed responses, empty responses, ApiResponse, and error type handling
๐๏ธ HTTP Method Annotations
Use HTTP method annotations in Kolibrium API to define GET, POST, PUT, PATCH, and DELETE endpoints with path parameters
๐๏ธ Authentication
Configure authentication in Kolibrium API with Bearer, Basic, API Key, and Custom auth types using the @Auth annotation and context parameters
๐๏ธ Code Generation
Generate and customize HTTP client code in Kolibrium API with client grouping, display names, scan packages, custom HTTP clients, and global headers
๐๏ธ Validation Rules
Compile-time validation rules in Kolibrium API for API specifications, request classes, parameters, and return types
๐๏ธ Complete Examples
Complete examples of Kolibrium API usage including full API definitions, generated client usage, DSL builders, and test harness patterns
๐๏ธ Troubleshooting
Troubleshoot common Kolibrium API issues including missing code generation, compilation errors, path variable mismatches, and authentication problems