What problem does it solve?
This skill eliminates inconsistent backend implementations by standardizing logging, error mapping, validation, method complexity, and queue integration practices for zoppy-api, reducing bugs and coupling across services.
Core Features & Use Cases
- Structured Logging: Mandates using LogService for all mutating operations and before queue dispatches while prohibiting console.log and direct interpolation of user input into messages.
- Error Mapping: Defines when to throw NotFoundException, UnprocessableEntityException, or BadRequestException to preserve correct HTTP semantics.
- Validation and Architecture Rules: Instructs use of ApplicationValidationBase for application-layer validation, domain-level DomainValidation<T> for entity rules, and encourages early returns and smaller private helper methods to control complexity.
- Queue Integration & Migration: Requires internal queue services for inter-service communication and deprecates using api-signatures HMAC HTTP calls to avoid coupling.
- Use Case: When implementing a create/update/delete operation or migrating an internal HTTP-based call to a queue, follow these conventions to ensure consistency across services.
Quick Start
Use the code-conventions skill to determine the correct logging, exception, validation, and queue patterns when implementing a new create or update operation in zoppy-api.
