Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ivamuno/nestjs-openapi

ivamuno224MIT1.0.15TypeScript support: included

null

readme

nestjs-openapi

Demo

Available running

npm start:demo

It starts a Nest application exposing:

Features

  • Extended OpenAPI decorators to allow examples.
  • New AsyncAPI decorators: AsyncApiChannel, AsyncApiSub, AsyncApiPub.
  • Support examples and discriminators for AsyncAPI as OpenAPI does (it means, the decorators are not 100% compatible with AsyncAPI spec).
  • Redoc integration for OpenAPI and AsyncAPI.
  • AMQP and Kafka are supported only for AsyncAPI.

Roadmap

  • Header and Traits support.
  • Support more protocols for AsyncAPI.
  • Try-it-out support and postman generation with Redoc.