#Swagger: Where could I find better docs for all available decorators and their use cases?

2 messages · Page 1 of 1 (latest)

proud steppe
#

I'm new to swagger, personally always have used typedoc myself, but I'm looking to explore alternatives.

The official docs hardly mention most of the decorators that are available to use, and there appears to be lack of any jsdoc/tsdoc comments that could help developers quickly look through and cherry-pick some that they might want to use.

To be fair, the official docs mention the core decorators that others (such as various responses) derive from, but I find it a little 🤏🏻 annoying that there's no docs on the numerous options provided by each decorator and short descriptions regarding each decorator's proper usage and use case.

Could I be pointed to a source where I might find relevant information on the matter, with example and best practices?

Additionally, I would be happy to contribute to the package by making a PR with relevant tsdoc comments for the majority of the decorators. ♥️ KKomrade

short field
#

The options passed to ApiProperty, ApiBody, ApiResponse and such are pretty much 1:1 copy of what the OpenAPI (former Swagger) spec defines, so the best place to learn about them is the spec.