Skip to main content

Built and signed on GitHub Actions

Danet's module to generate your OpenAPI/Swagger documentation from your code

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score
100%
Published
2 weeks ago (2.1.5)
T
Constructor

Generic constructor type

c
SpecBuilder
No documentation available
c
SwaggerModule

Responsible for generating and setting up Swagger documentationfor a Danet application. It provides methods to create a Swagger document based on the application'smodules and controllers, and to set up routes to serve the Swagger UI and JSON specification.

v
API_PROPERTY

Metadata key to store the property schema

v
API_SECURITY

A constant key used to store or retrieve api-security metadata.

v
API_SECURITY_DATA

A constant key used to store or retrieve api-security data metadata.

f
ApiBasicAuth

Indicate that the endpoint use basic authentication security.

f
ApiBearerAuth

Indicate that the endpoint use api bearer auth security.

f
ApiCookieAuth

Indicate that the endpoint use cookie security.

f
ApiOAuth2

Indicate that the endpoint use oauth2 security.

f
ApiProperty

Decorator to define API property metadata for a class property.

f
ApiSecurity

Decorator that indicate that an endpoint use a security mechanism.

f
BodyType

Decorator to indicate the body type of a request.

f
Optional

Decorator that marks a property or method as optional.

v
OPTIONAL_KEY

Metadata key to mark a property as optional

f
QueryType

Decorator to indicate the query type.

v
RETURNED_TYPE_KEY

Metadata key to store the returned type of a method

f
ReturnedType

Decorator to set metadata for the returned type of a method.

f
Tag

A decorator function to add an openAPI tag to a class or a method.

v
TAGS_KEY

A constant key used to store or retrieve tags metadata.This key is typically used in decorators to annotateclasses or methods with specific tags for documentation.