ApiParam class

Provides OpenAPI documentation for a path parameter.

Use this annotation along with @Param to document path parameters in the generated OpenAPI documentation.

Example:

@Controller('/api/users')
class UserController {
  @Get('/:id')
  @ApiOperation(summary: 'Get user by ID')
  Future<Response> getUserById(
    Request request,
    @Param('id') @ApiParam(description: 'User ID', required: true) String id
  ) {
    // Method implementation...
  }
}

Constructors

ApiParam({String? name, String description = '', bool required = false})

Creates an ApiParam annotation with the specified name, description, and required flag.

const

Properties

description → String

A description of the parameter.

final

hashCode → int

The hash code for this object.

no setter, inherited

name → String?

The name of the parameter.

final

required → bool

Indicates whether the parameter is required.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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