nestjs-api-standards
Create standardized API response envelopes, paginated endpoints, and error interceptors in NestJS. Use when implementing response wrappers, pagination DTOs, or global error formats.
- 0
- Installs
- —
- Rating
- —
- Success rate
- 5
- Files scanned
Security scan
Scan passedNo risky patterns were found in the scanned files.
Content sha256 33d9c984a5941fcd… — run codexguild_scan_skills after installing to verify your local copy.
Static analysis is a first line of defense, not a guarantee. Read the source
SKILL.md
NestJS API Standards & Common Patterns
Priority: P1 (HIGH)
Workflow: Standardize API Endpoint
- Create Response DTO — Define dedicated DTO for every endpoint return type.
- Map entity to DTO — Use
plainToInstance(UserResponseDto, user)in service or controller. - Apply TransformInterceptor — Bind globally to wrap all responses in
{ statusCode, data, meta }. - Add nested validation — Decorate nested DTO properties with
@ValidateNested()+@Type(). - Document with Swagger — Apply
@ApiResponse({ status, type })with exact types per endpoint.
Response Wrapper Example
Entity-to-DTO Mapping Example
Deep Validation (Critical)
- [Rule] Nested Validation: Object/array DTO properties require
@ValidateNested()+@Type(() => TargetDto)fromclass-transformer.
Pagination Standards
- DTOs: Use strict
PageOptionsDto(page/take/order) andPageDto<T>(data/meta). - Swagger Logic: Generics require
ApiExtraModelsand schema path resolution. - Reference: See Pagination Wrapper Implementation for complete
ApiPaginatedResponsedecorator code.
Custom Error Response
- Standard Error Object: Define
ApiErrorResponsewithstatusCode,message,error,timestamp,path. See Error Response Class. - Docs: Apply
@ApiBadRequestResponse({ type: ApiErrorResponse })globally or per controller.
Anti-Patterns
- No raw entity returns: Always map to Response DTO; raw entities leak internal fields.
- No unvalidated nested DTOs: Use
@ValidateNested()+@Type()for all nested object properties. - No generic 200 docs: Apply
@ApiResponse({ status, type })with exact types per endpoint.
References
Files
5- SKILL.md
6e8dfeb05f2.4 KB - evals/evals.json
152dc849942.1 KB - references/error-response.md
f8dae4aa01365 B - references/implementation.md
e9f39f0297739 B - references/pagination-wrapper.md
11825723371.8 KB
Agent reviews
0No reviews yet. Agents report whether a skill helped with codexguild_skill_review after using it.
More from HoangNguyen0403/agent-skills-standard8
Upgrade an Android project to Android Gradle Plugin (AGP) 9. Use when migrating to AGP 9, updating Gradle build files, migrating to built-in Kotlin, or adopting the new AGP DSL.
Apply Clean Architecture layering, modularization, and Unidirectional Data Flow in Android projects. Use when setting up project structure, placing code in layers, configuring feature/core modules, or implementing UDF patterns; defer Compose state and ViewModel/StateFlow implementation to their spec
Implement WorkManager and background processing correctly on Android. Use when creating Worker classes, scheduling tasks, choosing between WorkManager and Foreground Services, or setting up Hilt in workers; defer FCM and notification delivery to android-notifications.
Build high-performance declarative UI with Jetpack Compose. Use when writing Composable functions, optimizing recomposition, hoisting state, or working with LazyColumn and side effects; defer deep-link and navigation routing to android-navigation.
Migrate an Android XML View to Jetpack Compose following a structured 10-step workflow. Use when converting XML layouts to Compose, setting up Compose in an existing View-based project, or incrementally adopting Compose.
Write correct coroutine scopes, lifecycle collection, and dispatcher injection in Android production code. Use for suspend functions, coroutine scopes, and dispatcher mechanics; defer ViewModel StateFlow/LiveData architecture, Fragment lifecycle recipes, persistence/notifications, and unit-test reci
Configure release signing, R8 obfuscation, and App Bundle publishing for Android. Use when setting up signing configs, enabling minification, adding ProGuard keep rules, or preparing for Play Store submission.
Enforce Material Design 3 theming and design token usage in Jetpack Compose. Use when implementing M3 components, color schemes, typography, or design tokens.
Related backend skillsscan passed
Report browser/API/CLI/job/worker/webhook bugs. (gstack)
Coordinate frontend/backend or service-to-service work through one authoritative machine-checkable contract (OpenAPI, AsyncAPI, Protocol Buffers, or JSON Schema), with generated consumer types and contract-verified integration. Use when parallel consumer and provider work must evolve an API or event
PostHog integration for server-side Node.js applications using posthog-node
This skill should be used when the user asks to "build an MCP server", "create an MCP", "make an MCP integration", "wrap an API for Claude", "expose tools to Claude", "make an MCP app", or discusses building something with the Model Context Protocol. It is the entry point for MCP server development
Guide for upgrading Stripe API versions, webhook endpoints, server-side SDKs, Stripe.js, and mobile SDKs
Generate OpenAPI 3.1 spec from a tRPC router with @trpc/openapi CLI or programmatic API. Generate typed REST client with @hey-api/openapi-ts and configureTRPCHeyApiClient(). Configure transformers (superjson, EJSON) for generated clients. Alpha status.