openapi
NestJS OpenAPI (Swagger)
When to Use This Skill
Use this skill when:
- Documenting REST APIs
- Generating interactive API documentation
- Creating OpenAPI/Swagger specifications
- Adding API metadata and descriptions
- Defining request/response schemas
- Documenting authentication and security
- Generating TypeScript clients
- Testing APIs through Swagger UI
What is OpenAPI in NestJS?
The OpenAPI (Swagger) module provides decorators and tools to automatically generate API documentation from your NestJS application. It creates an interactive UI for testing endpoints and generates machine-readable API specifications.
Installation
More from ramziddin/ccplugins
security
NestJS security best practices including CORS, CSRF protection, Helmet for HTTP headers, rate limiting, encryption, and hashing. Use when implementing security features, hardening applications, or protecting against common vulnerabilities.
3authentication
NestJS authentication with JWT, Passport, local/JWT strategies, and auth guards. Use when implementing user login, token generation, protected routes, or integrating authentication systems.
3caching
NestJS caching with cache module, in-memory caching, Redis integration, cache interceptor, and TTL management. Use when implementing performance optimization, reducing database queries, or storing temporary data.
2exception-filters
NestJS exception filters for handling errors, customizing error responses, logging exceptions, and providing consistent error formatting across your application.
2cli
NestJS CLI for generating resources, managing workspaces, building applications, and development commands. Use when scaffolding NestJS projects, generating boilerplate code, or managing monorepo structures.
2testing
NestJS unit and E2E testing with Test.createTestingModule(), mocking dependencies, testing best practices, and integration testing strategies. Use when writing tests for controllers, services, or full application flows.
2