{"repo":"flamewow/nestjs-asyncapi","free":true,"listed":false,"github":"https://github.com/flamewow/nestjs-asyncapi","clone":"git clone https://github.com/flamewow/nestjs-asyncapi.git","description":"NestJS AsyncAPI module - generate documentation of your event-based services using decorators","language":"TypeScript","stars":234,"topics":["asyncapi","nestjs","nest","openapi","swagger"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"nestjs-asyncapi A NestJS module that auto-generates AsyncAPI 3.0 documentation for event-driven services — WebSocket gateways, microservices, and any class with the @AsyncApi decorators — in the same style as @nestjs/swagger for HTTP. Contents - Features - Installation - Quick start - Usage - Express vs Fastify - WebSocket gateways - Microservices - Channel bindings (Kafka / AMQP) - Security schemes - Document endpoints - Migrating from v1.x - Live preview - Contributing - License Features - Decorate any controller / gateway / service method with @AsyncApiSend or @AsyncApiReceive and have it appear in the rendered document - DTO introspection via @nestjs/swagger 's @ApiProperty decorator — same workflow as the HTTP side - Outputs the AsyncAPI 3.0 document as HTML, JSON, and YAML from configurable routes - Works with Express and Fastify HTTP adapters - Supports WebSocket gateways ( @nestjs/websockets ) and microservices ( @nestjs/microservices ) - Channel bindings for Kafka and AMQP - Security schemes: bearer / OAuth2 / API key / basic / cookie / user-password Installation The library bundles @asyncapi/generator (which depends on Puppeteer) but doesn't need Chromium for HTML rendering — the package ships with puppeteer skip chromium download set, so a fresh install does not download Chromium. Peer dependencies Peer Supported --- --- @nestjs/common ^10.0.0 \\ \\ ^11.0.0 \\ \\ ^12.0.0-0 @nestjs/core same @nestjs/swagger ^7.0.0 \\ \\ ^8.0.0 \\ \\ ^11.0.0 @nestjs/websockets same as @nestj","default_branch":null,"files":null,"tree":[],"storefront":"/r/flamewow","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/flamewow/nestjs-asyncapi/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}