Api class

Provides OpenAPI documentation for a controller.

Use this annotation on controller classes to specify the tag and description that will be used in the generated OpenAPI documentation. Tags are used to group related endpoints in the API documentation.

Example:

@Controller('/api/users')
@Api(tag: 'Users', description: 'User management endpoints')
class UserController {
  // Controller methods...
}

Constructors

Api({required String tag, String description = ''})

Creates an Api annotation with the specified tag and description.

const

Properties

description → String

A description of the API endpoints in this controller.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tag → String

The tag name for grouping related endpoints in the OpenAPI documentation.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited